An example website
This website is built using Hugo - it's a static website generator that takes simple markdown files and turns them into webpages. It does this by through the use of templates written in the Go language.
What's great about Hugo is that we don't have to create these templates from scratch - there are many themes that we can use out of the box.
Every time you edit a file on the main branch here on Github, an Action runs behind the scenes to compile the website and deploy it to Github's servers which will point to project-ida.github.io/website.
This approach is good for doing a small number of edits. If you're doing a lot of editing then it's better to work locally where you can edit and see the results of your changes in real time.
Hugo allows you to run what's called a local "dev server" which let's you to make edits locally and see the results in real time. In order to do this you need to install a couple of things:
For installing Hugo on Mac, the simplest way is running
brew install hugo
For installing Hugo on Windows the simplest way is running
choco install hugo-extended
After installing, go ahead and clone the repo
git clone https://github.com/project-ida/mit.git
And then go into the directory and run this to get your dev server started.
hugo server -D
Note, the
-Dwill render content that is marked as "Draft". If you're curious to see what Hugo is actually generating, then check out thepublicfolder.