Bitshifter Codedoc

Welcome to the Bitshifter Code Documentation portal (CodeDoc). Here you'll find various guidelines on how to use our libraries along with their respective API specifications and examples, how to integrate new libraries into our development environment and also general HowTo's and helpful articles.

Building

Prerequisites

• Install .NET SDK 10.0 or higher
• Install Node.js v20 or higher (Optional: It's required when using Create PDF Files)

Make sure you have .NET SDK installed, then open a terminal and enter the following command to install the latest docfx:

dotnet tool update -g docfx

To build the CodeDoc, run:

docfx docfx.json --serve

Now you can preview the website on http://localhost:8080.

To preview your local changes, save changes then run this command in a new terminal to rebuild the website:

docfx docfx.json

Publishing

The Bitshifter CodeDoc repository is automatically being published on every commit using a Azure Pipeline and accessible here.