Beta software: expect bugs and breaking changes...
The simplest way to transform a directory of .md files into a static site.
- Bring your own editor and host. Obsidian, Bear, Typora, VS Code... Netlify, Vercel, Cloudflare...
- Publish your Obsidian digital garden.
- Back to the future: edit .html layouts without compiling.
-
Simplicity at its Core: Just a
npx
command away to transform your markdown files into a minimalistic static site.
- Transform .md to html
- GFM markdown, with all the features supported by remark-gfm.
- That includes table, footnotes, even raw html tags, e.g.: iframe for embeds.
- Support images in markdown files.
- Wiki links:
[[Another Page]] => [Another Page](/another-page)
. - Auto header anchor links, so you can navigate to any H2-h5 headers directly.
- GFM markdown, with all the features supported by remark-gfm.
- Custom html Layout support (any layout.html files at the same level or above will be used, if none found, default layout will be used.)
- Filter docs with matching tags
--tags=publish:true
which will only render files withpublish
flag or--tags=draft:false
which will not render files withdraft
flag. - Automatically infer title from first H1
- Generates
sitemap.xml
at the output directory.- Requires
baseUrl
option orBASE_URL
env var, sincesitemap.xml
requires full URL. - If missing base url, no sitemap will be generated.
- Requires
- Automatically generates
robots.txt
Getting started with zenmd
is as easy as one, two!
- Generate site
npx zenmd <inputFolder> --output <outputFolder or default: ./dist>
# Or if you prefer to install to a global command:
npm install zenmd -g
zenmd ...
- Drag and drop the generated folder into Netlify
- Or
netlify deploy
- Publish:
npm publish --access public
- Built with remark
- Default theme used TailwindCSS Typography
- Alternatives: markdown-styles, remark-cli
Made by randomor, who also made ZenJournal