cbourgois / calavera

A (static) Single Page Application generator using Markdown files

Calavera, a static Single Page Application generator

Calavera helps to create a full-Javascript webapp from Markdown files.

Basically, it converts Markdown files stored in a Git repository to JSON-LD files using the Schema.org vocabulary. Those files include metadata extracted from the Git repository (author name, last modification date...).

JSON-LD files are easily consumed by JavaScript libraries and framework such as Angular, Flux and jQuery.

Websites generated with Calavera can easily (and freely) be hosted on GitHub Pages.

Install

Go programming language is the only required dependency to compile Calavera.

If you don't already have a Go workspace, create it:

$ mkdir -p ~/workspace/go
$ export GOPATH=~/workspace/go

Create the appropriate directory structure and download the source code:

$ mkdir -p ~/workspace/go/src/github.com/dunglas
$ cd ~/workspace/go/src/github.com/dunglas
$ git clone [email protected]:dunglas/calavera.git

Go to the source code directory, download external libraries and compile the program:

$ cd calavera
$ go get
$ go install

Usage

$ ~/workspace/go/bin/calavera input_directory output_directory

Markdown files from the input_directory will be converted to JSON-LD files in output_directory.

Options

• -prettify: Prettify json-ld output files

License

Calavera is distributed under the MIT license.

Credits

Written in Go (golang) by Kévin Dunglas and sponsored by Les-Tilleuls.coop.