MBDoc

This is the documentation for MBDoc, a markup language + compilation process that creates documents in various formats, with a focus on making it easy to create documentation.

The purpose of this document is to serve as an index towards the various parts covered by the documentation.

1 History and motivation

To get an introduction to what inspired this project in the first place, and the overarching goals of the project, go here.

While this part is not strictly neccessary to understand the project, it might help get an understanding of what kind of problems are ment to be solved by it and what it's supposed/not supposed to do.

2 The build pipeline

In order to undestand the different part that are done to complete a build, go here. It isn't neccesarrily required to create and build documentation, but an understanding of it helps to explain the different options used on the command line and how the individual parts of the process can be tinkered with.

3 The markup language

To use the program, a prerequisite is atleast one source file compile, and the documentation of the markup language can be found here.

4 Build files

The program can be used without build files, but they greatly speed up development and helps organizing larger projects. The structure and syntax of the build files can be found Here.

5 CLI

The documentation for the CLI is available here. While it documents the complete behaviour of the programs so doesn't it explain for example the syntax of the markup language or build files. To get a complete understanding of how to use the program, so are the previous parts needed.

6 The source code

The previous part document how the program can be used, but don't document how it's implemented, and doesn't describe the API. In order to use the project as a library and to extend on the source code, an overview of the codebase can be found here.