Build documentation fast and easy.
MarkDown Doc is a streamlined template designed to simplify the process of creating documentation. By writing content in MarkDown, you can maintain an efficient workflow while organizing your pages effortlessly through a configuration file.
You create your documentation as .md files, which are then processed using an adapted version of the MarkDown Converter (details about the modifications can be found here). This tool converts the MarkDown content into well-formatted HTML pages.
A navigable list of pages in your documentation is displayed on the left side of the interface, allowing you to easily browse and access different sections.
The main view displays the content loaded from your MarkDown files, providing a clean and readable layout.
Quickly navigate to specific sections on the current page using the right-hand sidebar, which lists all headings.
Use the search bar to find specific terms or topics within your documentation effortlessly.
Create and customize help and credits pages by writing them in MarkDown, just like the rest of your documentation.
- Clone the repository:
git clone https://github.com/7XDev/MarkDownConverter.git - Explore the customized MarkDown Converter.
- Learn how to build documentation here.
- Start creating.
This project has been actively co-developed together with MarkusHarnusek
View additional credits here