Skip to content

a markdown transculsion server- it eats recipe.hmd files, allowing you to weave markdown files together

License

Notifications You must be signed in to change notification settings

mixmix/hypermarkdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c834820 · Oct 31, 2015

History

75 Commits
Apr 18, 2015
Oct 31, 2015
Oct 31, 2015
Oct 31, 2015
Oct 25, 2015
Apr 18, 2015
Oct 27, 2015
Apr 18, 2015
Apr 18, 2015
Oct 17, 2015
May 31, 2015
Oct 25, 2015
May 21, 2015
May 25, 2015
Oct 31, 2015
Oct 27, 2015
Oct 17, 2015
Oct 31, 2015
Oct 31, 2015
Oct 25, 2015
Oct 25, 2015
Oct 11, 2015
Oct 31, 2015
Oct 17, 2015
Oct 17, 2015

Repository files navigation

hypermarkdown

This is a dynamic mardkown transclusion server - it parses special inclusion syntax and includes remote markdown, then renderes the resulting markdown.

parts of the project:

  • treeBuilder( markdownText, callback ) : reads text and recursively fetches markdown files that have been linked to in the +[file name](url) format. It stores the markdown (original and fetched) in a json tree, and passes this to the callback.
  • treePartialRender( tree ) : renders the markdown partials of a built tree into html, and returns that tree.
  • treeToHtml( tree ) : provides a couple of methods for rendering tree of html partials into a a single html string.
  • server : serves client static files, and provides and api which client-side code can request built and rendered trees of markdown.

notation

To include a MD file within your MD file, use the normal markdown-link syntax, prefixed with a '+'

e.g.

+[example include](https://github.com/mixmix/example-course/blob/master/README.md)

With normal markdown renderers this makes a link like this:

+example include

See a rendered example here

About

a markdown transculsion server- it eats recipe.hmd files, allowing you to weave markdown files together

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages