Skip to content

tjakk399/litesite

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Litesite

This static site generator uses Pandoc's template system in order to create a flat lightweight website for minimalist blogging, e.g. on a shared host or on a personal server, such as a Raspberry Pi.

All articles are presented and linked on the top site. Each article is placed on its own subsite with a unique URL.

The HTML template and (responsive) stylesheet are based on http://bettermotherfuckingwebsite.com. There are no Javascript or third-party dependencies.

Demo: https://heidenblog.de/

This repository doubles as the repository for the demo website.

Verified requirements

  • GNU bash 5.0.16
  • GNU Make 4.3
  • Perl 5.18
  • rsync 2.6.9
  • Pandoc 2.9.2

Installation

Git clone.

Test:

make site

Usage

  1. Create your HTML5 templates in src/. In order to use this repository as-is, you need:
  2. Create your articles in src/. Note:
    • Each article is represented by a plain text file in Pandoc (Markdown) format.
    • It is recommended to use a number prefix in the file name for manual sorting.
    • Subdirectories within src/ are ignored.
  3. If you need assets (such as images), put them into a separate directory, e.g. assets/.
  4. Adjust the configuration section in Makefile as documented.
  5. Run the commands below.

Refer to existing files as a guideline.

Commands

Clean the output directory:

make clean

Compile modified sources and synchronize the assets:

make site

Publish the site on a remote host by rsyncing the output directory:

make sync

Compile and publish in one go:

make

Todo

  • Pagination
  • Parameterised templates

About

A super-lightweight static site generator for fast & simple blogging

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published