Code Monkey home page Code Monkey logo

blog's Introduction

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 should always be the same as the newest release, with possible minor documentation-related fixups due to brainfarts. 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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.