Giter VIP home page Giter VIP logo

bookgen's Introduction

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

bookgen's People

Contributors

dependabot[bot] avatar hlabadi avatar webmaster442 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.