Introduction

mdbooksharp is a command line tool to create books with Markdown.

Based on mdbook with rewrited backend.

It is good for creating script-based books. If you do not need lua scripts or deep customization, better choose original mdBook.

Important

Thanks to mdbook! Without them, this project wouldn't be exists!

  • Lightweight Markdown files
  • Integrated search (based on mdbook).
  • Search improvements
    • mdbooksharp support any languages for search include multiple in one book for search.
  • Customizing by css files
  • Extensions provide custom page processing on all generation steps
  • Lua support for scripting without modifying mdbookshap
  • Localization by i18n
  • Integrated .NET solution

This guide is an example of what mdbooksharp produces. mdbooksharp is used by the Nabunassar TTRPG.

Contributing

mdbooksharp is free and open source. You can find the source code on GitHub and issues and feature requests can be posted on the GitHub issue tracker. You can feel free to send pull requests.

License

Based on mdBook.

The mdbooksharp source and documentation are released under the Mozilla Public License v2.0.