Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 3.81 KB

README.md

File metadata and controls

86 lines (60 loc) · 3.81 KB

zeptoblog

Maven Central Maven Central (snapshot) Codecov Java Version

com.io7m.zeptoblog

JVM Platform Status
OpenJDK (Temurin) Current Linux Build (OpenJDK (Temurin) Current, Linux)
OpenJDK (Temurin) LTS Linux Build (OpenJDK (Temurin) LTS, Linux)
OpenJDK (Temurin) Current Windows Build (OpenJDK (Temurin) Current, Windows)
OpenJDK (Temurin) LTS Windows Build (OpenJDK (Temurin) LTS, Windows)

Usage

Create a configuration file (in Java properties format):

# The blog title
com.io7m.zeptoblog.title = Example Blog

# The blog source tree
com.io7m.zeptoblog.source_root = /home/someone/blog-src

# The output directory tree
com.io7m.zeptoblog.output_root = /tmp/blog-out

# The number of posts per page
com.io7m.zeptoblog.posts_per_page = 30

# The site URI
com.io7m.zeptoblog.site_uri = http://blog.io7m.com/

# The author information that will appear in Atom feeds
com.io7m.zeptoblog.author = blog@io7m.com

# The default format of blog posts (CommonMark, here)
com.io7m.zeptoblog.format_default = com.io7m.zeptoblog.commonmark

Create posts by creating files in com.io7m.zeptoblog.source_root with names ending in .zbp.

Posts must consist of a series of commands that specify the date (in ISO 8601 format) and title of the post, followed by an empty line, followed by the body of the post in CommonMark format.

$ cat /home/someone/blog-src/2017/02/24/post.zbp
title An example post
date 2017-02-24T19:37:48+0000

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur
efficitur sed nisi ac volutpat.

![Ladybug](/2017/02/24/ladybug.jpg)

Files can appear anywhere in com.io7m.zeptoblog.source_root, including any subdirectory, and directory names do not carry any specific meaning. Organizing posts by year/month/day is merely a useful convention. Any files with names not ending in .zbp will be copied unmodified to the output directory.

Compile the blog:

$ java -jar com.io7m.zeptoblog.cmdline-0.2.0-main.jar compile -config blog.conf

Sign pages with gpg:

$ find /tmp/blog-out -name '*.xhtml' -type f -exec gpg -a --detach-sign -u 'my key id' {} \;

Use rsync to copy /tmp/blog-out to a site.

Real-world Examples

https://blog.io7m.com