Skip to content

A DocFX template patching the Default template

License

Notifications You must be signed in to change notification settings

ExtendedXmlSerializer/docfx-tmpl

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 

Repository files navigation

docfx-tmpl

A DocFX Template patching the Default template.

Supported DocFX version: v2.17.4

Changes from Default Template

  • Full Width (uses container-fluid instead of container).
  • Affix sidebar styled like Bootstrap Documentation.
  • Thinner TOC toggle button on mobiles.
  • Hides the IN THIS ARTICLE heading above sidebar.
  • Tabular views for Namespace.
  • Pretty tables for Class view.
  • Collapsible sections in API documentation.
  • Round Buttons for View-Source and Edit.
  • Different colors.

How to use

The template is contained in the source folder.

Clone or Download
In a terminal, run: git clone https://github.com/MathewSachin/docfx-tmpl.git

Apply Template
Use default, <relative path to src folder of this template>

In docfx.json (showing only relevant portion):

{
    "build": {
        "template": [
            "default",
            "docfx-tmpl/src"
        ]
    }
}

OR

In Command-line:

docfx -t default,docfx-tmpl/src

ScreenShots

Large

Small

XS

Navbar

About

A DocFX template patching the Default template

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 79.8%
  • JavaScript 20.2%