Packages

rest.tagpage

It splits the REST model into tag level model. With this plugin enabled, operations with the same tag are grouped into one page. If the operation is in multiple tags, it would be included in first tag level page.

docfx.json: template: ["default", "<output>/rest.tagpage.<version>/content"]

docfx: -t default,<output>/rest.tagpage.<version>/content

docfx init: nuget install rest.tagpage -OutputDirectory <output>

rest.operationpage

It splits the REST model into operation level model. If it's enabled together with rest.tagpage, the REST model will split to tag level first, then split to operation level.

docfx.json: template: ["default", "<output>/rest.operationpage.<version>/content"]

docfx: -t default,<output>/rest.operationpage.<version>/content

docfx init: nuget install rest.operationpage -OutputDirectory <output>

docfx-lightbox-plugin (Featherlight)

A template which adds a lightbox to each image, using the jquery plugin Featherlight.

docfx.json: "template":["default","docfx-lightbox-plugin/templates/lightbox-featherlight"]

docfx: -t default,docfx-lightbox-plugin/templates/lightbox-featherlight

docfx init: git clone https://github.com/roel4ez/docfx-lightbox-plugin.git docfx-lightbox-plugin

docfx-lightbox-plugin (Bootstrap Modal)

A template which adds a lightbox to each image, using the Modal window from Bootstrap.

docfx.json: "template":["default","docfx-lightbox-plugin/templates/bootstrap-modal"]

docfx: -t default,docfx-lightbox-plugin/templates/bootstrap-modal

docfx init: git clone https://github.com/roel4ez/docfx-lightbox-plugin.git docfx-lightbox-plugin

DocFx.Plugins.PlantUml

A template to render PlantUml diagrams from markdown code blocks.

docfx.json: "template":["default","DocFx.Plugins.PlantUml/template"]

docfx: -t default,DocFx.Plugins.PlantUml/template

docfx init: nuget install DocFx.Plugins.PlantUml -ExcludeVersion -OutputDirectory .