Commit 601d1199d0
Unsigned
Layout: unified · split
README.md +13 −22
| @@ -1,22 +1,23 @@ | |||
| 1 | # cleberg.net | 1 | # cleberg.net |
| 2 | 2 | ||
| 3 | This document describes the structure and usage of the `cleberg.net` project. | 3 | This repository holds the files for [cleberg.net](https://cleberg.net), a |
| 4 | The site is built and maintained using the Org-Mode publishing system within | 4 | static-site with blog posts, personal links, and more. |
| 5 | Emacs, supported by the weblorg package. This setup allows for generation of | 5 | |
| 6 | static HTML content from Org files using a declarative configuration. | 6 | This site uses [weblorg](https://github.com/emacs-love/weblorg) to build the |
| 7 | static site, which relies on [emacs](https://www.gnu.org/software/emacs/). | ||
| 7 | 8 | ||
| 8 | ## Site Structure | 9 | ## Site Structure |
| 9 | 10 | ||
| 10 | The project source files are written in Org-Mode format and reside in the | 11 | Content pages (e.g., blog posts) are written in org-mode and templates are |
| 11 | repository. These files are processed by the publishing engine to produce HTML | 12 | written in HTML. Weblorg can be used to build these files into a static site, |
| 12 | output, which can then be deployed to a web server. | 13 | which can then be deployed to a web server. |
| 13 | 14 | ||
| 14 | The main site components are: | 15 | The main site components are: |
| 15 | 16 | ||
| 16 | - Org source files containing content, including blog posts and pages. | 17 | - Org source files containing content, including blog posts and pages. |
| 17 | - A configuration file (`publish.el`) that specifies publishing parameters like | 18 | - A configuration file (`publish.el`) that specifies publishing parameters like |
| 18 | base URL, output directories, and export options. | 19 | base URL, output directories, and export options. |
| 19 | - Assets such as images and stylesheets, located in designated subdirectories. | 20 | - Assets such as images and style sheets, located in designated subdirectories. |
| 20 | - Utility scripts (e.g., `build.py`) to facilitate building and deployment. | 21 | - Utility scripts (e.g., `build.py`) to facilitate building and deployment. |
| 21 | 22 | ||
| 22 | ## Dependencies | 23 | ## Dependencies |
| @@ -24,10 +25,10 @@ The main site components are: | |||
| 24 | The publishing system depends on: | 25 | The publishing system depends on: |
| 25 | 26 | ||
| 26 | - Emacs text editor with Org-Mode. | 27 | - Emacs text editor with Org-Mode. |
| 27 | - The weblorg package, available at <https://github.com/emacs-love/weblorg>, which | 28 | - The weblorg package, available at <https://github.com/emacs-love/weblorg>, |
| 28 | provides advanced Org publishing functionality and theming support. | 29 | which provides advanced Org publishing functionality and theming support. |
| 29 | 30 | ||
| 30 | ## Viewing the Site Examples | 31 | ## Screenshots |
| 31 | 32 | ||
| 32 | Screenshots illustrating the site in both light and dark display modes are | 33 | Screenshots illustrating the site in both light and dark display modes are |
| 33 | included in the `./screenshots/` directory. | 34 | included in the `./screenshots/` directory. |
| @@ -53,7 +54,7 @@ configuration options and expected formats. | |||
| 53 | ## Setup Instructions | 54 | ## Setup Instructions |
| 54 | 55 | ||
| 55 | To obtain a working copy of this repository, execute the following commands | 56 | To obtain a working copy of this repository, execute the following commands |
| 56 | within a shell environment or Emacs’ shell interface: | 57 | within a shell environment or Emacs shell interface: |
| 57 | 58 | ||
| 58 | ```shell | 59 | ```shell |
| 59 | git clone https://git.cleberg.net/cleberg.net.git | 60 | git clone https://git.cleberg.net/cleberg.net.git |
| @@ -112,13 +113,3 @@ To add new blog content, follow this procedure within Emacs: | |||
| 112 | 3. Modify the new file as needed to add post content and metadata. | 113 | 3. Modify the new file as needed to add post content and metadata. |
| 113 | 114 | ||
| 114 | This method streamlines content creation by reusing a preformatted template. | 115 | This method streamlines content creation by reusing a preformatted template. |
| 115 | |||
| 116 | |||
| 117 | ## Contributing and Issue Tracking | ||
| 118 | |||
| 119 | Contributions and bug reports are tracked through the repository's issue tab on | ||
| 120 | GitHub. Users are encouraged to submit reports, feature requests, or pull | ||
| 121 | requests following standard repository guidelines. | ||
| 122 | |||
| 123 | For further details on the usage of Org-Mode, weblorg configuration, or | ||
| 124 | publishing workflows, consult the respective documentation sources. | ||