Find a file
2024-02-16 14:19:45 -03:00
.github/workflows Add go build actions workflow (#3) 2024-02-16 12:37:47 -03:00
commands Introduce config mod and struct (#2) 2024-02-16 12:39:19 -03:00
config Introduce config mod and struct (#2) 2024-02-16 12:39:19 -03:00
site Introduce config mod and struct (#2) 2024-02-16 12:39:19 -03:00
templates Introduce config mod and struct (#2) 2024-02-16 12:39:19 -03:00
.gitignore Initial commit 2024-02-09 11:28:59 -03:00
go.mod Introduce config mod and struct (#2) 2024-02-16 12:39:19 -03:00
go.sum Introduce config mod and struct (#2) 2024-02-16 12:39:19 -03:00
LICENSE Initial commit 2024-02-09 11:28:59 -03:00
main.go Introduce config mod and struct (#2) 2024-02-16 12:39:19 -03:00
README.md another example tweak 2024-02-16 14:19:45 -03:00

blorg

A presonal (small + opinionated) site generator with org-mode support.

(NOTE: this is stil a WIP, the doc below is a wishlist, not the current behavior.)

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:

$ blorg init myblog
> site name: My Blog
> author: Facundo Olano
> url: https://myblog.olano.dev

  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

$ cd myblog
$ blorg post "My First Post"
  added draft src/blog/my-first-post.org

# serve the site locally with live reload
$ blorg serve
  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
# Hello world!

this is my *first* post.
EOF

# remove the draft flag before publishing
$ sed -i '/^draft: true$/d' src/blog/my-first-post.org

$ blorg build
  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

For more details see the: