MarkdownProjectCompositor is a static markdown generator with compositor, using CommonMark, or cmark-gfm as its rendering engine.
and provide a pre-compiled windows version in releases, include cmark-gfm.exe, luajit.exe and lfs_ffi.lua.
- Lua or LuaJIT
- luafilesystem or luafilesystem via LuaJIT FFI
- markdown rendering engine, like cmark-gfm
- composite markdown source with different header, footer or style sheet in different project dir
- with pre process body step, the compositor can extend your own markdown syntax
$ lua MarkdownProjectCompositor.lua example/basic/config.lua example/basic
extend markdown syntax, '^' is newline:
- '^#title' <h1> title and html <head><title>
- link anchor '^#anchor'
- proj markdown file link as '[desc](proj#file#anchor)'
- footnote with paired '[desc](#name)'
- contents with '^#contents depth'
$ lua MarkdownProjectCompositor.lua example/feature/config.lua example/feature
http://suchang.net
http://suchang.net/blog
with config.lua
- recommand VSCode with Markdown All in One
- or https://github.com/jbt/markdown-editor, try it online