Compare commits
2 Commits
a7b0c45ca1
...
a4d03c8e8d
Author | SHA1 | Date | |
---|---|---|---|
a4d03c8e8d | |||
8aeeba1032 |
27
README.md
27
README.md
@ -9,36 +9,45 @@ It only is designed in bash script, and should work perfectly fine on any Unix
|
||||
like machine.
|
||||
|
||||
```
|
||||
git clone https://git.simonpetit.top
|
||||
git clone https://git.simonpetit.top/simonpetit/bob
|
||||
cd bob
|
||||
make test (optional)
|
||||
make test
|
||||
sudo make install
|
||||
```
|
||||
|
||||
or using Docker :
|
||||
|
||||
```
|
||||
docker pull git.simonpetit.top/simonpetit/bob:0.1.0
|
||||
```
|
||||
|
||||
## 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 :
|
||||
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
|
||||
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/<article_file>
|
||||
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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user