jorge/README.md

70 lines
1.6 KiB
Markdown
Raw Normal View History

2024-02-09 15:28:59 +01:00
# blorg
2024-02-13 18:58:07 +01:00
A presonal (small + opinionated) site generator with org-mode support.
2024-02-16 00:30:13 +01:00
(NOTE: this is stil a WIP, the doc below is a wishlist, not the current behavior.)
2024-02-13 18:58:07 +01:00
Install from binary:
$ wget https://github.com/facundoolano/blorg/releases/download/latest/blorg-$(uname -m) \
-o blorg && chmod +x blorg
Or install with go:
$ go install github.com/facundoolano/blorg
Usage:
2024-02-16 16:54:31 +01:00
```bash
2024-02-13 18:58:07 +01:00
$ blorg init myblog
2024-02-16 16:54:31 +01:00
> site name: My Blog
2024-02-16 18:19:45 +01:00
> author: Facundo Olano
> url: https://myblog.olano.dev
2024-02-13 18:58:07 +01:00
added myblog/README.md
added myblog/.gitignore
added myblog/config.yml
added myblog/layouts/base.html
added myblog/layouts/post.html
added myblog/src/index.html
added myblog/assets/css/main.css
added myblog/src/blog/hello.org
added myblog/src/feed.xml
added myblog/src/tags.html
2024-02-16 16:54:31 +01:00
2024-02-13 18:58:07 +01:00
$ cd myblog
$ blorg post "My First Post"
2024-02-16 16:54:31 +01:00
added draft src/blog/my-first-post.org
# serve the site locally with live reload
$ blorg serve
2024-02-13 18:58:07 +01:00
server running at http://localhost:4001/
2024-02-16 16:54:31 +01:00
# browse to the new post
$ open http://localhost:4001/blog/my-first-post
# add some content
2024-02-13 18:58:07 +01:00
$ cat >> src/blog/test.org <<EOF
2024-02-16 16:56:46 +01:00
# Hello world!
2024-02-13 18:58:07 +01:00
2024-02-16 16:56:46 +01:00
this is my *first* post.
EOF
2024-02-16 16:54:31 +01:00
# remove the draft flag before publishing
2024-02-16 16:55:46 +01:00
$ sed -i '/^draft: true$/d' src/blog/my-first-post.org
2024-02-16 16:54:31 +01:00
2024-02-13 18:58:07 +01:00
$ blorg build
2024-02-16 16:54:31 +01:00
wrote target/index.html
wrote target/assets/css/main.css
wrote target/blog/hello.html
wrote target/blog/my-first-post.html
wrote target/feed.xml
wrote target/tags.html
2024-02-13 18:58:07 +01:00
```
For more details see the:
- [Tutorial](https://blorg.olano.dev#tutorial)
- [Docs](https://blorg.olano.dev#docs)
- [Development blog](https://blorg.olano.dev#blog)