https://github.com/mixmix/hypermarkdown

a markdown transculsion server- it eats recipe.hmd files, allowing you to weave markdown files together
https://github.com/mixmix/hypermarkdown

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/mixmix/hypermarkdown
• Owner: mixmix
• License: gpl-2.0
• Created: 2015-04-18T01:06:42.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-01-06T21:38:47.000Z (over 2 years ago)
• Last Synced: 2024-04-22T03:19:25.806Z (5 months ago)
• Language: JavaScript
• Size: 345 KB
• Stars: 26
• Watchers: 0
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - mixmix/hypermarkdown - a markdown transculsion server- it eats recipe.hmd files, allowing you to weave markdown files together (others)

README

        
# 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](https://github.com/mixmix/example-course/blob/master/README.md)

[See a rendered example here](https://hypermarkdown.herokuapp.com/?source=https://github.com/mixmix/cultural_modules/blob/master/recipes/small_group_process.md)