Add Your Own Template and Tools

Available plugins:

  • memberpage

    It splits the YAML data model into member level. Currently it supports ManagedReference document type. With this template enabled, the class page contains lists of method overloads, fields, events and so on, while every method overload, field or event displays in a separated page.

    • Init:nuget install memberpage -OutputDirectory <output>
    • In command:-t default,<output>/memberpage.<version>/content
    • In docfx.json:template: ["statictoc", "<output>/memberpage.<version>/content"]
  • 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.

    • Init:nuget install rest.tagpage -OutputDirectory <output>
    • In command:-t default,<output>/rest.tagpage.<version>/content
    • In docfx.json:template: ["default", "<output>/rest.tagpage.<version>/content"]
  • 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.

    • Init:nuget install rest.operationpage -OutputDirectory <output>
    • In command:-t default,<output>/rest.operationpage.<version>/content
    • In docfx.json:template: ["default", "<output>/rest.operationpage.<version>/content"]
  • docfx-lightbox-plugin (Featherlight)

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

    • Init:git clone https://github.com/roel4ez/docfx-lightbox-plugin.git docfx-lightbox-plugin
    • In command:-t default,docfx-lightbox-plugin/templates/lightbox-featherlight
    • In docfx.json:"template":["default","docfx-lightbox-plugin/templates/lightbox-featherlight"]
  • docfx-lightbox-plugin (Bootstrap Modal)

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

    • Init:git clone https://github.com/roel4ez/docfx-lightbox-plugin.git docfx-lightbox-plugin
    • In command:-t default,docfx-lightbox-plugin/templates/bootstrap-modal
    • In docfx.json:"template":["default","docfx-lightbox-plugin/templates/bootstrap-modal"]
  • DocFx.Plugins.PlantUml

    A template to render PlantUml diagrams from markdown code blocks.

    • Init:nuget install DocFx.Plugins.PlantUml -ExcludeVersion -OutputDirectory .
    • In command:-t default,DocFx.Plugins.PlantUml/template
    • In docfx.json:"template":["default","DocFx.Plugins.PlantUml/template"]