paassg

Pandoc as a Static Site Generator.

The project is still at very early stage. There is no guarantee on stability.

The project homepage is generated by the project itself.

Features

• Hashtags. #features/hashtags
• Backlinks
• Auto-generated index of folders.
• navibar
• Name homepage as index.html instead of README.md.

Usage

Requirements:

• Pandoc
• Bash
• jq
• GNU Make

Clone the git repository, or add a submodule, under ./paassg of your documentation project. It is feasible to clone into other path or use a different folder name.

Creat a file named paassg.config.mk with the following content.

# Rename it if you clone the git repository under other location.
PAASSG_DIR = ./paassg

# Markdown files you want to convert into html
MARKDOWNS = README.md $(shell find docs -type -f -name '*.md')

# Static files
ASSETS = $(shell find assets -type f)

Then run the following command. The generated pages will be located under ./public by default.

make -f ./paassg/Makefile prepare -j &&
    make -f ./paassg/Makefile -j && 
    make -f ./paassg/Makefile build-tag-pages -j

Configuration

The configuration is just a Makefile, named paassg.config.mk. You can use your favorite automation tools to build it.

• PAASSG_DIR: the location of the git repository, paassg. By default, it is paassg.
• TEMP_DIR: the directory holding temporary files during building. By default, paassg.
• OUTPUT_DIR: the directory located generated files. By default, public.
• TAG_PATH_PREFIX: the path prefix of tag pages. By default, paassg/tags.
• PAASSG_APPEND_BACKLINKS: whether to show backlinks per page.

The following documents contain more information if you want to tweak or hack the project.

• Style Sheet