bob

Bob is a small static generator, for those who wants to maintain a personal website or blog.

Installation

It only is designed in bash script, and should work perfectly fine on any Unix like machine.

git clone https://git.simonpetit.top/simonpetit/bob
cd bob
make test
sudo make install

or using Docker :

docker pull git.simonpetit.top/simonpetit/bob:0.1.2

Usage

Publish : to convert a drafts in markdown into a html article

To write a post, create a markdown file in the drafts folder whose name will also be its title, and convert it to an html file, type the following command from the root.

Once your draft is ready to be published, move it into drafts/published and call bob

bob publish

Bob will convert all markdown files within drafts/published in html and put them into posts It will also update the index.html to add this newly article into its list.

Unpublish : to remove a published article

To remove a specific post, remove its counterpart from draft/published and rerun :

bob publish

This will remove the html files from the posts folder, and republish accordingly to the drafts/published list of files. The file index.html will be rewritten to match the actually published posts.

Help

See the help for additional command, such as modification of the main configuration of the blog.

bob help

TODO

Make a proper header/footer for the posts (e.g. adding links to social networks such as tweeter, github, dev.to ...).
Complete the CSS files.
Add a comment/like section ?
Consider adding configuration files for some/all posts (if they need special javascript included e.g. MathJax, AJAX, sockets ...).

1.7 KiB Raw Blame History

bob