Structure

This project uses a publishing script, among other modules, to define the components which are then used to generate the website. Emacs Lisp files inside the lisp directory all share one similarity, the op prefix, a local convention and a reference to the initials of the ox-publish library.

Setup

Clone the repository and its submodules:

git clone --recursive https://github.com/grtcdr/grtcdr.github.io.git grtcdr.tn

Building

If you wish to reproduce this site locally, the most overarching dependency is GNU Emacs. You’ll also want to install GNU Make to reap the benefits of the build system in use.

Once you’ve set that up, you should install this project’s development dependencies. To do that, position yourself at the project root and run npm ci. To build the project, run the make command.

Development

In order to fully utilize the site during development, you should serve the public directory with a web server. This project uses miniserve by default and thus has a recipe to quickly serve the site:

make serve

Deployment

This site is hosted on GitHub Pages, and utilizes a CI workflow to build and deploy the site with every commit made to the default branch.

The workflow is split into two major jobs: build and deploy.

1. build is responsible for producing the site; the output of this process generates an artifact, the public directory.
2. deploy receives this artifact and proceeds to deploy it to the

Copying

The content and source code of this site is licensed under the CC-BY-SA 2.0 and ISC licenses respectively.