https://github.com/pekrau/mdbook

Web display of a book written in Markdown. Uses Python, FastHTML, pico CSS, Marko, python-docx, fpdf2.
https://github.com/pekrau/mdbook

docx-generator fasthtml markdown pdf-generator

Last synced: 6 months ago
JSON representation

Web display of a book written in Markdown. Uses Python, FastHTML, pico CSS, Marko, python-docx, fpdf2.

• Host: GitHub
• URL: https://github.com/pekrau/mdbook
• Owner: pekrau
• Created: 2024-08-29T17:04:20.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-12-03T08:33:16.000Z (7 months ago)
• Last Synced: 2024-12-03T09:32:06.746Z (7 months ago)
• Topics: docx-generator, fasthtml, markdown, pdf-generator
• Language: Python
• Homepage:
• Size: 7.79 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://www.python.org/) using:

- [FastHTML](https://fastht.ml/)

- [pico CSS](https://picocss.com/)

- [Marko](https://marko-py.readthedocs.io/)

- [python-docx](https://python-docx.readthedocs.io/en/latest/)

- [fpdf2](https://py-pdf.github.io/fpdf2/)

- [PyYAML](https://pypi.org/project/PyYAML/)

- [bibtexparser](https://pypi.org/project/bibtexparser/)