README.md

darkFX - A dark theme for DocFX!

A dark template for documentation generated with DocFX. This is an override of the default template so you need to enable both in the docfx.json.

Live Demo

You can view a demo DocFX project with this template HERE.

Install

1. Download the source or the zipped file from the releases.
2. Create a templates folder in the root of your DocFX directory.
3. Copy the darkfx folder to the templates folder.
4. Update the docfx.json configuration to include the darkfx template:

   {
       "template": [
           "default",
           "templates/darkfx"
       ],
   }

Acknowledgement

Many thanks to Oscar Vásquez from which I borrowed the example pages and repository structure of his Material Theme for DocFX.