Markdown-driven static site.
Borrowed heavily from lineman-docs.
- Clone this repository.
- Install lineman.js if you haven't already.
- Run
npm install
to install required project dependencies. - Run
lineman run
while you work on writing markdown files. Visit the site on localhost:8000
The documentation topics live in app/pages/**/*.md
. Lineman regenerates the site on save, so you don't need to restart the server.
Include metadata at the top of the file. The required fields are slug
, and category
.
The category
value must match the name of the directory that the file lives in.
The ordinal
value allows posts to be sorted.
---
title: "Ruby"
slug: "ruby"
category: "languages"
ordinal: 1
---
Below the metadata, the documentation can be added using GitHub flavored markdown.
If you have multiple lineman apps, you may want to run this on something other than 8000
, which is the default.
$ WEB_PORT=9000 lineman run
The MIT License (MIT)
Copyright (c) 2014 Katrina Owen, _@kytrinyx.com