aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorChristian Cleberg <hello@cleberg.net>2024-03-29 01:30:23 -0500
committerChristian Cleberg <hello@cleberg.net>2024-03-29 01:30:23 -0500
commit41bd0ad58e44244fe67cb36e066d4bb68738516f (patch)
tree205e844650144648e58700df2b632c89298904d4 /README.org
parent797a1404213173791a5f4126a77ad383ceb00064 (diff)
downloadcleberg.net-41bd0ad58e44244fe67cb36e066d4bb68738516f.tar.gz
cleberg.net-41bd0ad58e44244fe67cb36e066d4bb68738516f.tar.bz2
cleberg.net-41bd0ad58e44244fe67cb36e066d4bb68738516f.zip
massive re-write from org-publish to weblorg
Diffstat (limited to 'README.org')
-rw-r--r--README.org62
1 files changed, 13 insertions, 49 deletions
diff --git a/README.org b/README.org
index 116185d..6507aa9 100644
--- a/README.org
+++ b/README.org
@@ -5,54 +5,19 @@
[[https://cleberg.net][cleberg.net]] is my personal webpage.
-This README is viewable on [[https://git.cleberg.net/cleberg.net.git/tree/README.org][cgit]] (raw), or on [[https://cleberg.net/README.html][my website]] (html).
+This README is viewable on [[https://git.cleberg.net/cleberg.net.git/tree/README.org][rgit]].
** Overview
-This website & blog uses [[https://orgmode.org/][Org-Mode]], published with =org-publish=.
+This website & blog uses [[https://orgmode.org/][Org-Mode]], published with [[https://github.com/emacs-love/weblorg][weblorg]].
** Configuration
-In order to configure the project for publishing, add the following code to your =~/.emacs= file (for Doom, =~/.doom.d/config.el=).
-
-#+begin_src lisp
-;; org-publish
-(require 'ox-publish)
-
-(setq org-publish-project-alist
- `(("blog"
- :base-directory "~/Source/cleberg.net/"
- :base-extension "org"
- :recursive t
- :publishing-directory "~/Source/cleberg.net/public/"
- :publishing-function org-html-publish-to-html)
- ;; HTML5
- :html-doctype "html5"
- :html-html5-fancy t
- ;; Disable some Org's HTML defaults
- :html-head-include-scripts nil
- :html-head-include-default-style nil
- ;; Generate sitemap
- :auto-sitemap t
- :sitemap-filename "sitemap.org"
- ;; Customize head, preamble, & postamble
- :html-head "<link rel='stylesheet' href='/static/styles.css' type='text/css'>"
- :html-preamble ""
- :html-postamble ""
- ("static"
- :base-directory "~/Source/cleberg.net/static/"
- :base-extension "css\\|txt\\|jpg\\|gif\\|png"
- :recursive t
- :publishing-directory "~/Source/cleberg.net/public/"
- :publishing-function org-publish-attachment)
-
- ("cleberg.net" :components ("blog" "static"))));; org-publish
-(require 'ox-publish)
-#+end_src
+Everything is configured within the =publish.el= file. Refer to the weblorg documentation for further configuration options.
** Building
-Local testing can be done via [[https://www.gnu.org/software/emacs/][Emacs]].
+Local testing can be done via [[https://www.gnu.org/software/emacs/][Emacs]] or through the command line.
To get running:
@@ -62,22 +27,21 @@ cd cleberg.net
emacs -nw
#+end_src
-Within Emacs, open any of the repository files. In Doom, I do this with =Spc f f= and selecting =README.org=. Once a file has been opened, you can publish the project with =C-c C-e P a=.
+Within Emacs, open any of the repository files. In Doom, I do this with =Spc f f= and selecting =README.org=. Make any changes necessary to customize the project.
+
+To publish, you can use the =build.sh= script (change the deployment target!) or you can run the following commands.
-If you need to re-publish unchanged files, I recommend using the following command:
+Use the =ENV= environment variable to determine which base URL weblorg will use. If ENV is ommitted, it will default to =localhost:8000=. If =ENV=prod=, weblorg will look in the =publish.el= file for the production base URL.
-#+begin_src lisp
-M-: (org-publish "project name" t)
+#+begin_src sh
+ENV=prod emacs --script publish.el
#+end_src
-The files will be published to the =public= directory.
+The files will be published to the =.build= directory. You can deploy these files to the target through any number of methods, such as =scp= or SFTP.
** Tasks
-*** TODO Create RSS feed
-Possible Solution: [[https://writepermission.com/org-blogging-rss-feed.html][Org mode blogging: RSS feed]]
-Possible Solution: [[https://www.zoraster.org/blog/script-to-generate-rss-feed][Script to Generate RSS Feeds]]
+*** DONE Create RSS feed
*** TODO Format all blog posts with =M q=
-*** TODO Create script to auto-generate the =/blog/= list and =/= most recent posts
-Possible Solution: [[https://taingram.org/blog/org-mode-blog.html#orgde61a58][Sitemap]]
+*** DONE Create script to auto-generate the =/blog/= list and =/= most recent posts
*** TODO Figure out how to get filetags to show up