From a4d03c8e8d88e7a8031407a74c4491c0c0183398 Mon Sep 17 00:00:00 2001 From: simonpetit Date: Mon, 9 Dec 2024 14:13:55 +0000 Subject: [PATCH] Completing readme.md --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 56b6dc1..38df47c 100644 --- a/README.md +++ b/README.md @@ -27,24 +27,27 @@ docker pull git.simonpetit.top/simonpetit/bob:0.1.0 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 : +from the root. + +Once your draft is ready to be published, move it into `drafts/published` and call `bob` ``` -bob publish ./drafts/ +bob publish ``` -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. +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 unpublish ./posts/ +bob publish ``` -This will remove the html file from the `posts` folder, and put back the draft from -`./draft/published` into the `./draft` folder. +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