Code Monkey home page Code Monkey logo

docfx-tmpl's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.