axelvanherle / raspberryPiSite

A Hugo-powered website that allows for easy markdown post submissions and runs on any host. It boasts a user-friendly design and reliable performance.

Home Page:https://axelvanherle.github.io/raspberryPiSite/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

raspberryPiSite

A website built by Axel Vanherle with Hugo that allows users to submit posts in markdown format. It's designed to run on any host, making it accessible and reliable. With a clean and simple design, users can easily navigate and find what they're looking for, while the robust back-end (you, but for now my raspberry pi 3B) ensures smooth performance.

https://axelvanherle.github.io/raspberryPiSite/

Ways to contribute

  • By adding any post that you want! It's that simple.
  • Fix errors or add minor improvements.

Rules for submission

  • You have to fork this and create a pull request to add posts.
  • Model submission files after example.md. Put them in content/posts/.
  • Tag it correctly.

Cloning

When cloning you might need to run git submodule update --init --recursive. Submodules (the theme) may not get cloned automatically, this is what I (and maybe you) might need to do.

To clone the source files so you can host this website you need to clone the gh-pages branch. To do this run git clone -b gh-pages https://github.com/axelvanherle/raspberryPiSite.git.

Running it on your server

Method 1

You can simply use the getghpages.sh script to pull the website from the github pages branch, and reload caddy.

It assumed you have root acces,you have caddy installed and your caddy files is looking for sites in /var/www/raspberryPiSite.

Method 2

You can user the buildsource.sh script to pull the latest version of this git repo, and built it using hugo. You have to change the script so the baseURL matches the one you plan on hosting on.

This scripts clones the repo, moves the builded website to the dir you ran the script in, and then removes the github repo, leaving the public/* directory, do as you wish with this.

About

A Hugo-powered website that allows for easy markdown post submissions and runs on any host. It boasts a user-friendly design and reliable performance.

https://axelvanherle.github.io/raspberryPiSite/


Languages

Language:Shell 100.0%