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

improwing readme

Browse Source
This commit is contained in:
Simon Petit 2024-11-16 12:02:40 +01:00
parent 1ef57d8807
commit 6976b4856f
1 changed files with 18 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -11,22 +11,36 @@ like machine.
``` ```
git clone https://git.simonpetit.top git clone https://git.simonpetit.top
cd bob cd bob
make test (optional)
sudo make install sudo make install
``` ```
## Usage ## 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 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 :
``` ```
bob publish bob publish ./drafts/<article_file>
``` ```
The publishing command will rep-ublish all the drafts, that is why Note that the article does not have to have a particular extension, however
anytime you want a post removed, delete in from the drafts folder and re-publish it will be placed in the `draft/published` folder with the `.md` extension.
your blog. 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 See the help for additional command, such as modification of the main configuration
of the blog. of the blog.
@ -41,14 +55,5 @@ bob help
such as tweeter, github, dev.to ...). such as tweeter, github, dev.to ...).
* Complete the CSS files. * Complete the CSS files.
* Add a comment/like section ? * Add a comment/like section ?
* Adding a git component, and a server configuration to allow synchronisation.
Maybe the drafts folder on the personal computer triggers changes on the git
repo of the server which re-publishes the blog automatically.
* Add a way to do all the construction of the blog on the personal computer but
to send the html files to a distant server.
* Consider adding configuration files for some/all posts (if they * Consider adding configuration files for some/all posts (if they
need special javascript included e.g. MathJax, AJAX, sockets ...). need special javascript included e.g. MathJax, AJAX, sockets ...).
* Add a preview function for TRUE drafts being written
* Take into account the headers possibilities of multimarkdown, which could
replace the self header writing process and include other features such as
Mathjax