source{d} blog

This is the repository for the source{d} blog, which generates styled static HTML from markdown files.

If you came here to learn how to set up the blog in your computer, to write/preview/deploy a new blog post, you should check:

Blog setup requirements and Build
How to contribute

Requirements

You need to have Yarn installed to build the js and css assets. It also lets you locally serve the blog to test and validate it while you are developing.

You can ensure if it is available in your machine running:

yarn --version; # prints your Yarn version

The blog also uses:

Hugo: to build the static html from the markdown content files; it is automatically downloaded and installed at building time.
Caddy: to serve the static files in production; it is provided by the caddy docker image

Build

You need to satisfy the project requirements, and then run from the project root:

make build;

It will generate all the static files that will be served by the Caddy server from the docker image. In case you only want to preview the blog, you can read the Preview the blog section

Preview the blog

To locally serve the blog, you need to satisfy the project requirements, and then run from the project root:

make serve;

Finally, go to http://localhost:8484

Contributing

If you want to contribute to this project, write a new blog post, or edit an existing one, you can follow the contribution guidelines.

Deploying

Automatically deployed, see here.

License

GPL v3.0, see LICENSE.

The editorial content itself is licensed under Creative Commons BY-SA 4.0, see LICENSE.