bakemd

Do you really need a ton of js over docs?

This package is built around that question. bakemd simply renders md files into html for you to serve.

Set the theme and all necessary SEO attributes in a config (see configuration), then:

npx bakemd build

The output is a dist folder with html files that any tool can serve.

What's in the dist

• all your md files as html files
• 7kb of css
• 1.1kb of js: theme switching and a copy-to-clipboard script, that's it.

Lighthouse:

Additional features

• dev mode with HMR: npx bakemd dev
• mobile-friendly layout
• set detailed SEO attributes
• sitemap.xml autogenerated
• llms.txt autogenerated

Limitations

As you noticed, JS is almost non-existent. That's because React, which is used to render the html pages, is not in the client bundle. If you want a lot of interactivity, this package is not for you.

Where to go next

• Getting started walks through the first build.
• Writing pages covers frontmatter and routes.
• Theming covers colors, fonts and icons.

Example

You are inside the example. The source is here: github.com/romenkova/bakemd/docs