@atom-forge/bookmd
v0.1.15
Published
Static course portals from Markdown: local and Git-hosted courses, local browser preview and change-based publishing.
Maintainers
Readme
@atom-forge/bookmd
Static book collections from Markdown. A collection (a config file, a book list and content) runs the bookmd CLI, which owns the SvelteKit app, the Markdown generator and renderer, a browser-safe content core, a local preview (/@dev), Git book sources and change-based publishing. The output is a folder of static files, so it can be hosted anywhere (GitHub Pages included).
Quick start
The fastest start is the bookmd-starter template repository: Use this template, switch GitHub Pages to GitHub Actions, edit the Markdown in content/. Details: docs/deploy-a-book.md.
To run it locally (Bun 1.4.0+, Node 22.12+) see docs/cli.md.
Documentation
User documentation, in docs/:
- Writing books: structure, metadata, supported content.
- Publishing on GitHub Pages.
- Books from other GitHub repositories, including private ones.
- Self-hosting the static output.
- Commands and configuration:
bookmdcommands,portal.config.ts, local preview,bookmd plan.
Release notes: CHANGELOG.md.
