Polyglot.Notebook.Docfx.Plugin
0.0.0-beta.3
dotnet add package Polyglot.Notebook.Docfx.Plugin --version 0.0.0-beta.3
NuGet\Install-Package Polyglot.Notebook.Docfx.Plugin -Version 0.0.0-beta.3
<PackageReference Include="Polyglot.Notebook.Docfx.Plugin" Version="0.0.0-beta.3" />
<PackageVersion Include="Polyglot.Notebook.Docfx.Plugin" Version="0.0.0-beta.3" />
<PackageReference Include="Polyglot.Notebook.Docfx.Plugin" />
paket add Polyglot.Notebook.Docfx.Plugin --version 0.0.0-beta.3
#r "nuget: Polyglot.Notebook.Docfx.Plugin, 0.0.0-beta.3"
#addin nuget:?package=Polyglot.Notebook.Docfx.Plugin&version=0.0.0-beta.3&prerelease
#tool nuget:?package=Polyglot.Notebook.Docfx.Plugin&version=0.0.0-beta.3&prerelease
Polyglot Notebook Docfx Plugin
Why?
Docfx is a great tool for creating documentation, but it lacks support for Polyglot Notebooks . This plugin aims to fill that gap by providing a way to render Polyglot Notebooks in Docfx.
Everything supported by Docfx in markdown files is also supported in Polyglot Notebooks.
Hiding Cells
If you want to hide cells from displaying in the final output,
you can use the hidden-in-docfx
attribute in the cell metadata.
{
"metadata": {
"tags": [
"hidden-in-docfx"
]
}
}
This allows you to keep cells in your notebook for setup or notebook only purposes, but not have them show up in the final docfx output.
Attributions
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. |
-
net8.0
- Docfx.Common (>= 2.78.3)
- Docfx.DataContracts.Common (>= 2.78.3)
- Docfx.Plugins (>= 2.78.3)
- System.Composition (>= 8.0.0)
- System.Text.Json (>= 9.0.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
0.0.0-beta.3 | 113 | 4/21/2025 |
0.0.0-beta.2 | 115 | 4/20/2025 |
0.0.0-beta.1 | 122 | 4/20/2025 |