Installation for development of BlogIt

BlogIt BlogIt is a command line program for curating front matter in CommonMark (Markdown) documents used in producing a blog. BlogIt primary purpose is curating the fornt matter posts. It also supports a preprocessor for handling markdown linked files as HTML linked files and code include blocks. Additional functionality includes editing, checking and publishing the CommonMark document to a blog directory structure.

Here’s an example of creating a blog from scratch while levaraging BlogIt.

# Pick an editor, example nano in the case
export EDITOR=nano
mkdir -p $HOME/Site/website/blog
cd $HOME/Site/website
# Create your first post
nano $HOME/Documents/FirstPost.md
# Create/curate the Front Matter for your first blog post
BlogIt edit $HOME/Documents/FirstPost.md
# Check to make sure everything is ready to go
BlogIt check $HOME/Documents/FirstPost.md
# Publishing into your blog's directory tree
BlogIt $HOME/Document/FirstPost.md
# See the blog post ready in your blog directory
tree blog

Run a Common Mark to HTML converter like Pandoc on the Common Mark files to produce HTML. Then you’re ready to run PageFind for search and FlatLake to render your blog’s JSON API. It also works with antennaApp.

Quick install with curl or irm

There is an experimental installer.sh script that can be run with the following command to install latest table release. This may work for macOS, Linux and if you’re using Windows with the Unix subsystem. This would be run from your shell (e.g. Terminal on macOS).

curl https://rsdoiel.github.io/BlogIt/installer.sh | sh

This will install the programs included in BlogIt in your $HOME/bin directory.

If you are running Windows 10 or 11 use the Powershell command below.

irm https://rsdoiel.github.io/BlogIt/installer.ps1 | iex

If your are running macOS or Windows

You may get security warnings if you are using macOS or Windows. See the notes for the specific operating system you’re using to fix issues.

Installing from source

Required software

Steps

  1. git clone https://github.com/rsdoiel/BlogIt
  2. Change directory into the BlogIt directory
  3. Make to build, test and install
git clone https://github.com/rsdoiel/BlogIt
cd BlogIt
make
make test
make install