Skip to content
Declarative static site generator
Awk Makefile CSS HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
LICENSE.md
Makefile
README.md
_nav.txt
_template.html
index.md
md2html.awk
mksite
styles.css
thingies.content.html

README.md

mksite

Static site builder based on a makefile.

  • renders pages from markdown
  • depends only on common shell tools
  • is fast

Get it

git clone git://celehner.com/mksite

Installation

sudo make install

or, to change default prefix (/usr/local/):

sudo make install PREFIX=/usr

Usage

In your site directory, create a _template.html.

To make a page, create a .md Markdown file or .content.html HTML file.

To hide files from navigation, add them to a file called _hidden.

To build your site, run mksite.

More advanced usage

In your site directory, create a Makefile. Have it include mksite, and any additional rules you need to build or deploy your site.

$ cat Makefile
include $(shell which mksite)

deploy:
	rsync -avz . example.org:/path/to/www/

Credits

Inspired by sw suckless webframework.

Styles from suckless.org and garbe.us.

Markdown renderer by Jesus Galan (yiyus).

Todo

  • Handle nested directories.
  • Do something smart about the index page.
You can’t perform that action at this time.