Skip to content

tg-x/pandit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

title subtitle author
Pandit
Minimalist Pandoc-based static site generator

About

Pandit uses Pandoc to generate HTML files from Markdown, Org-mode, reStructuredText, and AsciiDoc files.

To start using Pandit, include the following files in your repository:

Makefile : Build instructions

css.mk : Stylesheets to include in the HTML

css-x.mk : Stylesheets to copy to the output directory

defaults.yaml : Default options for Pandoc

For each source file, the default options are read from all of these files, if they exist:

  • defaults.yaml in the repository root
  • defaults.yaml in the current directory
  • <basename>.yaml (e.g. example.yaml for example.md)

The generated site can be viewed on the local file system, or served by a web server.

To generate the site to be accessed from the local file system, use:

make

To generate the site to be served by a web server, and transform links to remove the .html extension and the index.html ending, use:

make WEB=1

Dependencies

Pandit strives to be minimalist, it only depends on pandoc, git, and make.

Usage

This example sets up a site with the tufte-pandoc-css template and tufte-css stylesheets.

mkdir pub
git submodule add https://github.com/p2pcollab/pandit pub/pandit
git submodule add https://github.com/p2pcollab/tufte-pandoc-css pub/tufte-pandoc-css
git submodule add https://github.com/p2pcollab/tufte-css pub/tufte-css
ln -s pub/pandit/Makefile
cp pub/pandit/config/tufte/* .
make WEB=1

Repository

See this repository for the source code and issue tracker.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Releases

No releases published

Packages

No packages published