hachibu / md_spa

A command-line tool to compile a Markdown file into a single HTML file or a standalone executable

md_spa

Have you ever wanted to build a single-page application inside of one giant Markdown file? Well, now you can with the help of md_spa!

With md_spa you can build an entire single-page application inside of a Markdown file and compile it down to a single HTML file or a standalone executable web server.

Requirements

• Crystal

Install

git clone https://github.com/hachibu/md_spa.git
cd md_spa
make install

Uninstall

make uninstall

Usage

Compile to HTML

md_spa examples/index.md --build=html
open examples/index.html

Compile to Standalone Executable

md_spa examples/index.md --build=exe
examples/index.exe --port=4567

Live Edit Mode

md_spa examples/index.md --serve

Development

make build && bin/md_spa

Test

make test

Contributing

1. Fork it (https://github.com/hachibu/md_spa/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new pull request

Contributors

• hachibu - creator, maintainer
• mgeraci