setup

Minimal setup with github pages

  1. Fork the repository of this blog (note: this repository per default uses github actions which are only free for public repositories)

  2. In your repository settings, set up github pages to deploy using github actions (SETTINGS -> PAGES -> SOURCE: Github Actions)

  3. Your blog should be live in about 1 minute at https://<your-github-username>.github.io/<your-repo-name>

For editing the blog you can either edit the code directly or use the preconfigured pagescms.

Editing with pagescms

  1. Go to pagescms and log in with your github account and authorize the app.

  2. Add your repository to pagescms and open it.

  3. Now you can edit your website configuration, about page, description and blog posts directly in the browser.

  4. Your changes will be automatically pushed to your repository and deployed to github pages in about 1 minute everytime you hit save.

Editing the code

  1. Set up your blog info in src/config.json (leaving SITE, BASE, and MANUAL_SITE_BASE, as they are).

  2. Add your blog posts in src/content/blog/

  3. Add your info in src/content/info/:

  • description.md is used for the homepage description
  • about.md is used for the about page