Skip to content

markdown project static generator & compositor, with feature to configure different stylesheet and extent syntax.

Notifications You must be signed in to change notification settings


Folders and files

Last commit message
Last commit date

Latest commit



29 Commits

Repository files navigation


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.




  • 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

Basic Example

$ lua MarkdownProjectCompositor.lua example/basic/config.lua example/basic

Feature Example

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

Live Example

with config.lua

Markdown Editor