Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Markdown → HTML
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.gitignore
Makefile
README.html
README.md
package.json

README.md

HTMLify

HTMLify can do both dynamic (on-the-fly) and static conversion from Markdown to HTML. No server side (PHP/Perl etc.) involved.

Example

HTML file containing the following markup can be opened in a web browser to display this .

<!DOCTYPE html><html><body>
<script src="htmlify.js" data-url="README.md"></script>
</body></html>

The same HTML file can be processed, using the following command, to embed the text and produce a static HTML.

node htmlify.js README.html README-static.html

Features

  • Single script for dynamic conversion and for compilation.

  • Can be installed via NPM.

  • Automatic refresh in dynamic mode.

  • Relative URLs correction.

  • Customization of generated HTML before embedding.

  • Document title can be set from Markdown document heading.

Dependencies

Compiled script has no dependencies.

Execution Modes

  1. Execute source code in a browser, load via lobrow.

  2. Execute source code in Node, load via standard require.

  3. Execute webpack-compiled code in a browser.

  4. Execute webpack-compiled in Node.

Compilation

  1. Execute npm update.

  2. Execute make (nmake on Windows).

Compatibility

  • Node

  • Safari

  • Chrome (needs --allow-file-access-from-files flag to work with local files).

  • Firefox

  • Internet Explorer

License

Apache 2

Something went wrong with that request. Please try again.