mirror of
https://github.com/facundoolano/jorge.git
synced 2024-11-16 07:47:40 +01:00
update expected api in readme
This commit is contained in:
parent
a4279aae0d
commit
ed34828b0b
1 changed files with 23 additions and 16 deletions
39
README.md
39
README.md
|
@ -15,10 +15,10 @@ Or install with go:
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
|
|
||||||
```shell
|
```bash
|
||||||
$ blorg init myblog
|
$ blorg init myblog
|
||||||
site name: My Blog
|
> site name: My Blog
|
||||||
author: Facundo
|
> author: Facundo
|
||||||
|
|
||||||
added myblog/README.md
|
added myblog/README.md
|
||||||
added myblog/.gitignore
|
added myblog/.gitignore
|
||||||
|
@ -30,28 +30,35 @@ $ blorg init myblog
|
||||||
added myblog/src/blog/hello.org
|
added myblog/src/blog/hello.org
|
||||||
added myblog/src/feed.xml
|
added myblog/src/feed.xml
|
||||||
added myblog/src/tags.html
|
added myblog/src/tags.html
|
||||||
|
|
||||||
$ cd myblog
|
$ cd myblog
|
||||||
$ blorg post "My First Post"
|
$ blorg post "My First Post"
|
||||||
added src/blog/my-first-post.org
|
added draft src/blog/my-first-post.org
|
||||||
$ blorg serve &
|
|
||||||
|
# serve the site locally with live reload
|
||||||
|
$ blorg serve
|
||||||
server running at http://localhost:4001/
|
server running at http://localhost:4001/
|
||||||
|
|
||||||
|
# browse to the new post
|
||||||
|
$ open http://localhost:4001/blog/my-first-post
|
||||||
|
|
||||||
|
# add some content
|
||||||
$ cat >> src/blog/test.org <<EOF
|
$ cat >> src/blog/test.org <<EOF
|
||||||
# Hello world!
|
# Hello world!
|
||||||
|
|
||||||
this is my *first* post.
|
this is my *first* post.
|
||||||
EOF
|
EOF
|
||||||
$ open http://localhost:4001/blog/my-first-post
|
|
||||||
$ blorg pub
|
# remove the draft flag before publishing
|
||||||
drafts:
|
$ sed -i '/^draft: true$/d' your_file.md
|
||||||
1. blog/my-first-post.org
|
|
||||||
choose file to publish: 1
|
|
||||||
$ blorg build
|
$ blorg build
|
||||||
added target/index.html
|
wrote target/index.html
|
||||||
added target/assets/css/main.css
|
wrote target/assets/css/main.css
|
||||||
added target/blog/hello.html
|
wrote target/blog/hello.html
|
||||||
added target/blog/my-first-post.html
|
wrote target/blog/my-first-post.html
|
||||||
added target/feed.xml
|
wrote target/feed.xml
|
||||||
added target/tags.html
|
wrote target/tags.html
|
||||||
```
|
```
|
||||||
|
|
||||||
For more details see the:
|
For more details see the:
|
||||||
|
|
Loading…
Reference in a new issue