Skip to content

A C# book generator, similar to GitBook, but better

License

Notifications You must be signed in to change notification settings

webmaster442/BookGen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

f07babd · May 23, 2022
Mar 2, 2022
Feb 6, 2022
Oct 8, 2021
May 23, 2022
May 23, 2022
May 23, 2022
Mar 21, 2022
May 23, 2022
Mar 22, 2022
May 23, 2022
May 23, 2022
May 23, 2022
May 23, 2022
Feb 18, 2022
Nov 7, 2021
Apr 19, 2022
Oct 18, 2019
Sep 1, 2019
Jun 9, 2020
Feb 18, 2022
Feb 18, 2022
May 23, 2022
May 23, 2022
Mar 10, 2022
Oct 8, 2021
Mar 10, 2022
Mar 10, 2022
Mar 10, 2022
Feb 18, 2022

Repository files navigation

logo

BookGen - A C# documentation generator

BookGen is a command line toolchain for writing books and documentation in markdown. It was inspired by GitBook. Generaly speeking you can call it a static website generator, but it has some neat features compared to other products.

It is designed to be cross platform, but It's developed and tested under Windows. It features a web based, cross platform Markdown editor.

  • MIT Licensed
  • Written in C#, targets .NET 6.0
  • Extremely fast, compared to GitBook and other NodeJs stuff
  • It hasn't got a template engine, so you don't have to learn a new template language. However it's extendable via shortcodes, like wordpress
  • Can be extended with Scripting API
  • Can be extended with NodeJs, Python, Php Scripts
  • Should be cross platform (Only tested & developed on windows)
  • Can resize & convert pictures during build.
  • Syntax highlighting is rendered during compile for Epub and printable documents.
  • Many output formats:
    • Static website with Bootstrap template
    • Printable or Word processor importable plain HTML
    • EPub v. 3.0
    • Wordpress compatible XML export file

To Build and develop you will need:

Getting the repo

git clone https://github.com/webmaster442/BookGen.git
cd BookGen
git submodule init
git submodule update

Documentation

https://github.com/webmaster442/BookGen/wiki