From b940d3cd7aede92f60e20d6bfa800dc81dddaa67 Mon Sep 17 00:00:00 2001 From: Christian Cleberg Date: Fri, 29 Mar 2024 01:51:12 -0500 Subject: format README --- README.org | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.org b/README.org index 6507aa9..155f469 100644 --- a/README.org +++ b/README.org @@ -13,7 +13,8 @@ This website & blog uses [[https://orgmode.org/][Org-Mode]], published with [[ht ** Configuration -Everything is configured within the =publish.el= file. Refer to the weblorg documentation for further configuration options. +Everything is configured within the =publish.el= file. Refer to the weblorg +documentation for further configuration options. ** Building @@ -22,22 +23,26 @@ Local testing can be done via [[https://www.gnu.org/software/emacs/][Emacs]] or To get running: #+begin_src shell -git clone https://git.cleberg.net/cleberg.net.git -cd cleberg.net -emacs -nw +git clone https://git.cleberg.net/cleberg.net.git 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=. Make any changes necessary to customize the project. +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. +To publish, you can use the =build.sh= script (change the deployment target!) or +you can run the following commands. -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. +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 sh ENV=prod emacs --script publish.el #+end_src -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. +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 -- cgit v1.2.3-70-g09d2