Related Information

If you are not familiar with any type of coding or developing docs as code, that is OK. The purpose of this page is to assist you in building a simple documentation website from scratch to learn this stuff.

To ensure that you can follow easily the procedures you find here, you need to install a set of tools and get access to services. Familirize yourself with the sources provided below, to ensure you can go through all steps without hustle.

The following table contains links to helpful resources and tools.

Link	Description
GitHub	A service intended for storing project source files based for example on various programming languages. Be sure to check the documentation provided and learn how to use the service to upload your project files.
Material for MkDocs	An open source custom theme that can change the look and feel of a website. After creating your website, you can use this solution to make it prettier and more accessible to others.
MkDocs	A static site generator that builds and runs a static website based on Markdown and YAML files. By using this tool, you can verify on the fly the changes you make to the project.
Read the Docs	A service that builds and publishes online a website. When your project is ready, you can link this service with your GitHub repository and make your website public.
Visual Studio Code	A free application for coding and also creating documentation. You can use it to configure your project and fill it with content.