🔧 Documentation Generator 🔧

A lightweight C# tool for transforming Markdown (.md) documentation into fast, customizable static websites.

Documentation Generator allows you to quickly turn Markdown files into a fully customizable, static website that can be deployed with no extra work. You can use an out-of-the-box Theme or modify the modular HTML files to perfectly fit any layout, color scheme or style.

Why Documentation Generator?

Documentation Generator is built to be lightweight and developer-first. Every page is created from a template that can be easily modified, replaced or left as-is to take advantage of small file sizes and fast perfomance using a clean built-in theme.

The Development experience is designed to be as simple and easy as possible. There's tools to preview what your site will look like in real-time, easy building, and complete freedom under the MIT license to remove any watermarks, branding, or anything else you don’t need on your site.

Getting Started

To begin creating a Documentation Generator site, download the setup from the Releases section. After installing Documentation Generator, create a new folder to hold your Markdown files and add a navbar.json file. This file controls how pages in your documentation ara accessed through the Navigation Bar.

This is an example of a valid navbar.json:

{
  "Titles": [
    {
      "Title": "Fruits",
      "Pages": {
        "Tomato": "tomato.md",
        "Apple": "apple.md",
      }
    },
    {
      "Title": "Vegetables",
      "Pages": {
        "Carrot": "carrot.md",
        "Lettuce": "lettuce.md",
      }
    }
  ]
}

This makes 2 titles, 'Fruits' and 'Vegetables', each with two pages linking to a .md file. After you have a working navbar.json create a config.json file, this file specifies extra details about how your site behaves.

This is an example of a valid config.json that builds with the 'Minimal' Theme:

{
    "Theme": "Minimal"
}

Building The Site

Once you have a valid navbar.json, navigate to its location in your directory and run DocumentationGenerator "./" in the console. This will generate a Build folder containing all the .HTML, .CSS, .JS files, alongside any images or resources required for the site.

Third-Party Libraries

Documentation Generator uses the following third-party C# libraries:

• Fleck (v1.2.0)

  • Licensed under the MIT License
  • View License

• Markdig (v0.41.0)

  • Licensed under the BSD-2-Clause License
  • View License

• System.Runtime.Serialization.Json (v4.3.0)

  • Licensed under the Microsoft End User License Agreement (MS-EULA)
  • View License