Editing Website

Editing Website

What is DocFX

DocFX is an API documentation generator for .NET, which currently supports C#, VB and F#. It generates API reference documentation from triple-slash comments in your source code. It also allows you to use Markdown files to create additional topics such as tutorials and how-tos, and to customize the generated reference documentation. DocFX builds a static HTML website from your source code and Markdown files, which can be easily hosted on any web server (for example, github.io). Also, DocFX provides you the flexibility to customize the layout and style of your website through templates.

Install DocFX

Add the bin folder to the PATH environment variable so you can run it anywhere.

Edit the page

Cloning the website repository

All editing takes place in the docfx_project folder.

If you want to Change something in the Wiki or the API(besides the Index.md) you need to go to the corresponding repositories.

Change the CSS of the page

templates -> default -> styles edit the main.css

If you are looking for a specific class, the CSS class is found using the browser's inspector.

Editing the content in the template

open templates -> default -> partials folder

here you can find all templates e.g. the footer or the navbar these .partial are written in HTML and can be edited.

Testing the Website

Clone the folder so you don't change the API or the Wiki submodules

In the root directory execute the build.cmd and let it run

Go to the docs folder and enter the docfx serve command

Page is now running locally under localhost:8080

Website push

If everything works and looks good, push your changes from the cloned repository.

👷 Engine Developer

Implementation details

The API and the Wiki are submodules, which means they are links to the repositories.

The advantage of this is that the API and the wiki are always up-to-date.

The API is created directly with a toc.yml file in contrast to the Wiki,

this gets its toc.yml with the help of the GitHubWikiSidbarToDocFX in the bin folder.

The GitHubWikiSidbarToDocFX.exe takes the _Sidebar from the wiki and creates the toc.yml from it.