All Projects → MathewSachin → docfx-tmpl

MathewSachin / docfx-tmpl

Licence: MIT license
A DocFX template patching the Default template

Programming Languages

CSS
56736 projects
javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to docfx-tmpl

dotnet-eud
DevExpress .NET Controls End-User Documentation
Stars: ✭ 50 (+47.06%)
Mutual labels:  docfx
DiscordFX
DocFX template to create documentation similar to Discord
Stars: ✭ 26 (-23.53%)
Mutual labels:  docfx

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

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].