Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.11 KB

README.md

File metadata and controls

34 lines (25 loc) · 1.11 KB

mdbook

Web display of a book written in Markdown.

  • Contents hierarchically organized into sections and texts.
  • Indexing of terms.
  • Reference handling.
  • Footnotes.
  • Export contents to DOCX or PDF file.

Installation notes

Environment variables:

  • MDBOOK_DIR: Absolute path to the directory containing the mdbook books. Required.
  • MDBOOK_USER: User name for the administrator user. Required.
  • MDBOOK_PASSWORD: Password for the administrator user. Required.
  • MDBOOK_DEVELOPMENT: When defined, puts app into development mode. Optional.
  • MDBOOK_APIKEY: When defined, allows using a http request header entry 'mdbook_apikey' for access. Optional.

Software

This code has been lovingly hand-crafted. No AI tools were used in its development.

Written in Python using: