Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ngzhian/ocs


https://github.com/ngzhian/ocs

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

# OCS

Simple static blog generator

## Features

- Generates static HTML pages from markdown
- Fast
- OCaml code that's easy to read for learning

## Developing

```
$ opam install core omd mustache ezjsonm
$ ocaml setup.ml -configure
$ ocaml setup.ml -build
$ ocaml setup.ml -install
```

Your markdown files should be in a directory.
Template files are in a folder called `template`.
OCS understands two template files right now:

- `index.html`
- `post.html`

In the directory, run ocs:

```
$ ocs
```

By default all the html files will be generated in the same directory.
This entire directory can then be uploaded GitHub pages.

Your markdown files can have special metadata that ocs recognizes at the top of the file.

```
Title: Post title
Date: 2016-04-01
```

An example layout is found in the `example/` folder