Commit 2fcfb7bb46
Unsigned
Layout: unified · split
README.org +13 −8
| @@ -13,7 +13,8 @@ This website & blog uses [[https://orgmode.org/][Org-Mode]], published with [[ht | |||
| 13 | 13 | ||
| 14 | ** Configuration | 14 | ** Configuration |
| 15 | 15 | ||
| 16 | Everything is configured within the =publish.el= file. Refer to the weblorg documentation for further configuration options. | 16 | Everything is configured within the =publish.el= file. Refer to the weblorg |
| 17 | documentation for further configuration options. | ||
| 17 | 18 | ||
| 18 | ** Building | 19 | ** Building |
| 19 | 20 | ||
| @@ -22,22 +23,26 @@ Local testing can be done via [[https://www.gnu.org/software/emacs/][Emacs]] or | |||
| 22 | To get running: | 23 | To get running: |
| 23 | 24 | ||
| 24 | #+begin_src shell | 25 | #+begin_src shell |
| 25 | git clone https://git.cleberg.net/cleberg.net.git | 26 | git clone https://git.cleberg.net/cleberg.net.git cd cleberg.net emacs -nw |
| 26 | cd cleberg.net | ||
| 27 | emacs -nw | ||
| 28 | #+end_src | 27 | #+end_src |
| 29 | 28 | ||
| 30 | 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. | 29 | Within Emacs, open any of the repository files. In Doom, I do this with =Spc f |
| 30 | f= and selecting =README.org=. Make any changes necessary to customize the | ||
| 31 | project. | ||
| 31 | 32 | ||
| 32 | To publish, you can use the =build.sh= script (change the deployment target!) or you can run the following commands. | 33 | To publish, you can use the =build.sh= script (change the deployment target!) or |
| 34 | you can run the following commands. | ||
| 33 | 35 | ||
| 34 | 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. | 36 | Use the =ENV= environment variable to determine which base URL weblorg will use. |
| 37 | If ENV is ommitted, it will default to =localhost:8000=. If =ENV=prod=, weblorg | ||
| 38 | will look in the =publish.el= file for the production base URL. | ||
| 35 | 39 | ||
| 36 | #+begin_src sh | 40 | #+begin_src sh |
| 37 | ENV=prod emacs --script publish.el | 41 | ENV=prod emacs --script publish.el |
| 38 | #+end_src | 42 | #+end_src |
| 39 | 43 | ||
| 40 | 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. | 44 | The files will be published to the =.build= directory. You can deploy these |
| 45 | files to the target through any number of methods, such as =scp= or SFTP. | ||
| 41 | 46 | ||
| 42 | ** Tasks | 47 | ** Tasks |
| 43 | 48 | ||