zeptoblog
A small static blog generator.
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.
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:
$ zeptoblog compile --file 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
Releases & Development Snapshots
Releases
You can subscribe to the atom feed to be notified of project releases.
The most recently released version of the package is 1.0.0.
1.0.0 Release (2024-05-16Z)
- Initial public release.
The compiled artifacts for the release (and all previous releases) are available on Maven Central.
Maven Modules
<dependency> <group>com.io7m.zeptoblog</group> <artifactId>com.io7m.zeptoblog.cmdline</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.zeptoblog</group> <artifactId>com.io7m.zeptoblog.commonmark</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.zeptoblog</group> <artifactId>com.io7m.zeptoblog.core</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.zeptoblog</group> <artifactId>com.io7m.zeptoblog.glossary</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.zeptoblog</group> <artifactId>com.io7m.zeptoblog.tests</artifactId> <version>1.0.0</version> </dependency>
Development Snapshots
At the time of writing, the current unstable development version of the package is 1.0.1-SNAPSHOT.
Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.
Manual
This project does not have any user manuals or other documentation beyond what might be present on the page above.
Sources
This project uses Git to manage source code.
Repository: https://www.github.com/io7m-com/zeptoblog
$ git clone --recursive https://www.github.com/io7m-com/zeptoblog
Issues
This project uses GitHub Issues to track issues.
License
Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.