Volt-DocFXv3-Theme

License Discord YouTube

Voltstro’s DocFX v3 theme. Based off DocFX’s official theme.

Features

  • It’s dark theme
  • Has some other customization features
  • Idk, other stuff

Getting Started

Usage

Prerequisites

DocFX V3-Beta

Please ensure that you are using DocFX v3 beta. This theme will not work for DocFX v2 (the current stable one).

Installation

Change your template option to https://gitlab.com/Voltstro-Studios/doctools/volt-docfxv3-theme-package. Example:

{
  "template": "https://gitlab.com/Voltstro-Studios/doctools/volt-docfxv3-theme-package",
  ...
}

Once you have your template set, build using docfx build. To show contributors on the pages, set the DOCFX__SECRETS__GITHUB_TOKEN environment variable to a GitHub token with repo and user user:email scopes defined.

Development

Prerequisites

Yarn
Node 17.x
DocFX V3-Beta

Please ensure that you are using DocFX v3 beta, and have it installed globally! This theme will not work for DocFX v2 (the current stable one).

Building

  1. Run yarn in project root.
  2. Run yarn run start to start the development environment.
  3. When ready, run yarn run build and yarn run prepare. This will place your built template into build/.

License

This project is licensed under the MIT license, see the LICENSE file for details.

Credits

Original theme by DocFX team.

GitHub

View Github