Markbook

Write books in CommonMark.

Markbook allows full books to be written in CommonMark.

Read the user guide on https://symbitic.github.io/markbook/.

If you like this project, please consider doing one of the following:

• Starring me on GitHub
• Contributing
• Buying me a soda (can't have coffee -- my kidney's would explode)

Getting Started

Markbook provides binary files for Windows, macOS, and Linux. Download the latest release at https://github.com/Symbitic/markbook/releases/latest.

Alternately, Markbook can be built manually:

git clone https://github.com/Symbitic/markbook.git
cd markbook
npm install
npm run build
npm run watch

Features

• Build/Serve/Init/Clean commands.
• Auto-reload on file changes.
• Package markbook as a binary file for easier system-wide install.
• Generate HTML from CommonMark files and a Handlebars theme.
• Table of Contents.
• Mobile-friendly interface.
• Generate PDF (requires Chrome or Chromium installed)
• Generate EPUB (very basic for the moment).

Planned

• User-supplied themes.
• Better rendering efficiency.
• Consider using TypeScript (@babel/preset-typescript).
• Better/More tests.
• Release on NPM.
• Expose an API for developer use.
• Support other templating engines (pug, nunjucks).
• Find typeface for ebooks (Amazon Kindle and Google Play Books each has custom typeface specific for reading ebooks).
• Mermaid, graphviz, or PlantUML diagrams.
• Add Pandoc/rmarkdown extensions.
• Add remark-lint command to allow linting/spell-checking.
• Support deploying to gh-pages.

Contributing

Please see CONTRIBUTING.md.

License

Licensed under the MIT license. See LICENSE.md for more details.

Copyright © 2018-2019 Markbook Contributors