Skip to content

JeffInChrist/template

 
 

Repository files navigation

Default docfx Site Template

Default site template for https://github.com/dotnet/docfx

Development Setup

To develop the template:

  • Install .NET Core
  • Install latest docfx pre release:
dotnet tool update -g docfx --version "3.0.0-*" --add-source https://docfx.pkgs.visualstudio.com/docfx/_packaging/docs-public-packages/nuget/v3/index.json
  • Build the samples website using this template
docfx build samples --template .
  • Start a local HTTP static file server in _site. http-server is a good option if you already have node js.
http-server samples/_site

To show contributor list locally, create a docfx.yml file under %USERPROFILE%/.docfx with the following content:

secrets:
  githubToken: {your-github-personal-access-token}

Make sure the GitHub personal access token has read access to repo and user.email.

About

Contains the default site template for https://github.com/dotnet/docfx

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 52.1%
  • JavaScript 45.6%
  • Liquid 2.3%