Markdown WebBook

Part of the Document Writing Tools project — a CLI tool that builds Markdown files into a static website using the kernux-theme Next.js theme.

Features

• Markdown to Web — Converts .md / .mdx files into a fully navigable static site.
• Search — Client-side full-text search via FlexSearch.
• Feedback — Collect page-level feedback backed by GitLab issues.
• Glossary — Auto-generated glossary page from abbreviations.yaml.
• Diff / Synopsis — Compare two versions of a document side-by-side.
• Self-Assessment — Embed questionnaires extracted from Markdown comments.
• Themes — Ship with opencode, bund, and kernux visual themes.
• Multi-Language — File-based locale routing with configurable locales.

Usage

# Build a static site
markdown-webbook -i ./content -o ./out

# Development mode with live-reload
markdown-webbook -i ./content --watch

To make a content page the site index, set siteIndex: true in its frontmatter. The page keeps its regular route and / redirects to it. This also works for a folder start page such as docs.mdx next to docs/ or docs/index.mdx.

Run markdown-webbook --help for the full list of options (theme, logo, feedback, i18n, etc.).

For detailed documentation see https://easywebsite.opencode.de/.

Known Limitations

Development server requires webpack mode

The remarkAbbrev remark plugin used by withMarkdownWebBook cannot be serialized by Turbopack (Next.js 16+ default dev bundler). The generated template already configures next dev --webpack in its package.json. Production builds (next build) are unaffected.

Contributing

Please refer to the contribution guidelines for more information.

License

This project is licensed under the EUPL-1.2 license.