Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
doc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
bm
 
 

README.md

BM

Blog Maker - Build a blog with bash, make, and other GNU shell utilities.

example blog image

BM generates static sites. Thus they will be blazing fast even when hosted on cheap hardware (think raspberry pi) or on slow connections (think Tor onion services). This is due to their underlying simplicity and tiny size, therefore browsers are able to aggressively cache the pages. BM still comes with some great features. See below.

Important

This project follows semantic versioning and thus every major version has the potential for breaking changes. You can find information about what those are at the following places.

  • in CHANGELOG.md (the same place you can find all changes)
  • on the github release page
  • under the BM tag on my blog (which doubles as an example BM website!)

Development on this project has mostly stalled. What little remains can be found on GitHub.

Requirements

BM only requires programs commonly already found on GNU/Linux systems. While many of the programs may be found on non-GNU/Linux systems (such as OS X), BM assumes they are the GNU variety.

You also need a web server such as nginx to serve up the generated files.

Features

Non-exhaustive list.

  • Uses Markdown to format post content.
  • Creates tag pages to list all posts which contain a given tag.
  • Generates post previews of dynamic length for the homepage.
  • Automatically regenerates blog after every post edit.
  • Optionally automatically sign all output files with a pgp key.
  • Optionally pin one or more posts to the top of the homepage.
  • Optionally autocreate a table of contents for a post.
  • Optionally generate an RSS feed.
  • Keeps track of post time, post modification time, and post author.
  • Quickly change the style of your website with themes

For more information, see the wiki.

Branches

master is the bleeding edge release and may not be the same as the latest tagged release. Realistically, it will probably be very close. If you would like to work on BM, it would most likely be best to branch off of the latest master.

Each release has a tag. They used to have branches by the same name, then the branches got pruned over time, and after v4.0.0 there will be no new release branches. Releases will only have tags.

Help and Documentation

See the wiki for more usage information. You may also enjoy the configuration, options, and advanced configuration pages.

Issues

Please report issues via the issue tracker

About

Blog Maker - Build a blog with bash, make, and other GNU shell utilities. Ongoing development has essentially stopped.

Topics

Resources

License

Packages

No packages published
You can’t perform that action at this time.