Skip to content
markdown project static generator & compositor, with feature to configure different stylesheet and extent syntax.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


MarkdownProjectCompositor is a static markdown generator with compositor, using CommonMark, or cmark-gfm as its rendering engine.




  • 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

recommand, try it online

You can’t perform that action at this time.