Polyglot.Notebook.Docfx.Plugin 0.0.0-beta.3

This is a prerelease version of Polyglot.Notebook.Docfx.Plugin.
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
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Polyglot.Notebook.Docfx.Plugin" Version="0.0.0-beta.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Polyglot.Notebook.Docfx.Plugin" Version="0.0.0-beta.3" />
                    
Directory.Packages.props
<PackageReference Include="Polyglot.Notebook.Docfx.Plugin" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Polyglot.Notebook.Docfx.Plugin --version 0.0.0-beta.3
                    
#r "nuget: Polyglot.Notebook.Docfx.Plugin, 0.0.0-beta.3"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=Polyglot.Notebook.Docfx.Plugin&version=0.0.0-beta.3&prerelease
                    
Install Polyglot.Notebook.Docfx.Plugin as a Cake Addin
#tool nuget:?package=Polyglot.Notebook.Docfx.Plugin&version=0.0.0-beta.3&prerelease
                    
Install Polyglot.Notebook.Docfx.Plugin as a Cake Tool

Polyglot Notebook Docfx Plugin Polyglot Notebook Docfx Plugin

Nuget

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

Icons created by juicy_fish

Product 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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