initial: org-garden
This commit is contained in:
28
README.org
Normal file
28
README.org
Normal file
@@ -0,0 +1,28 @@
|
||||
#+title: org-garden
|
||||
|
||||
An [[https://orgmode.org/][org-roam]] to static website publishing pipeline. Converts =.org= notes into a rendered site using Emacs/[[https://ox-hugo.scripter.co/][ox-hugo]] for export and [[https://quartz.jzhao.xyz/][Quartz 4]] for site generation.
|
||||
|
||||
* Usage
|
||||
|
||||
#+begin_example
|
||||
org-garden serve <notes-dir> # dev server with live reload
|
||||
org-garden build <notes-dir> # production static build
|
||||
org-garden export <notes-dir> # org → markdown only
|
||||
#+end_example
|
||||
|
||||
* Running with Nix (recommended)
|
||||
|
||||
#+begin_src sh
|
||||
nix run . -- serve <notes-dir>
|
||||
nix run . -- build <notes-dir>
|
||||
#+end_src
|
||||
|
||||
* Running with Mix
|
||||
|
||||
#+begin_src sh
|
||||
mix deps.get
|
||||
mix escript.build
|
||||
./org_garden serve <notes-dir>
|
||||
#+end_src
|
||||
|
||||
Requires =QUARTZ_PATH= to point to a Quartz install with =node_modules= for =serve= and =build= commands.
|
||||
Reference in New Issue
Block a user