Go to file
Simon Petit 8e773a914c
All checks were successful
continuous-integration/drone/push Build is passing
Init dockerfile
2024-12-05 14:43:06 +01:00
lib adding comment 2024-12-05 14:42:45 +01:00
test adding new link test 2024-12-05 13:26:14 +01:00
.drone.yml adding -y 2024-12-05 13:30:22 +01:00
.gitignore improving installation + adding variable to execute awk script 2024-10-28 22:06:49 +01:00
bob modifying the principle : all to be published article shall be in the published folder, and bob publish, publish them all 2024-12-05 11:56:19 +01:00
Dockerfile Init dockerfile 2024-12-05 14:43:06 +01:00
Makefile improving installation + adding variable to execute awk script 2024-10-28 22:06:49 +01:00
README.md improwing readme 2024-11-16 12:02:40 +01:00

bob

Bob is a small static generator, for those who wants to maintain a personal website or blog, all from the command line.

Installation

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

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

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 :

bob publish ./drafts/<article_file>

Note that the article does not have to have a particular extension, however it will be placed in the draft/published folder with the .md extension. It will also update the index.html to add this newly article into its list.

Unpublish : to remove a published article

bob unpublish ./posts/<article_file>

This will remove the html file from the posts folder, and put back the draft from ./draft/published into the ./draft folder.

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 ...).