simonpetit/bob
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Completing readme.md
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
simonpetit 2024-12-09 14:13:55 +00:00
parent 8aeeba1032
commit a4d03c8e8d
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -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 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 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/<article_file> bob publish
``` ```
Note that the article does not have to have a particular extension, however Bob will convert all markdown files within `drafts/published` in html and put them into `posts`
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. It will also update the `index.html` to add this newly article into its list.
### Unpublish : to remove a published article ### Unpublish : to remove a published article
To remove a specific `post`, remove its counterpart from `draft/published` and rerun :
``` ```
bob unpublish ./posts/<article_file> bob publish
``` ```
This will remove the html file from the `posts` folder, and put back the draft from This will remove the html files from the `posts` folder, and republish accordingly to the `drafts/published` list of files.
`./draft/published` into the `./draft` folder. The file `index.html` will be rewritten to match the actually published posts.
### Help ### Help