Polyglot.Notebook.Docfx.Plugin

Polyglot Notebook Docfx Plugin

Nuget Coverage Quality Gate Status CD Build Check Markdown

Docfx plugin for Polyglot Notebooks 📓

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.

Edit this page