A website template for your final project 🔮
By using this template you would be able to create your own website and deploy it on Github Pages. This project creates a static website, to test it locally (on your machine) you need to install Hugo. This facilitates you to develop it and display the changes in real-time.
Therefore, you can click on the Use this template button (including all branches!) 😉
More details are explained in depth below. To briefly explain how this project works:
- You can write all the content in Markdown using the same syntax you may have already used in Jupyter Notebooks
- Hugo makes it easier to build all the HTML web pages and reuse the same template across different pages
- Github Actions allows running for free a job that builds and deploy the website
- Github Pages offers to publish a static website for free
If you managed to install Hugo on your machine (official guide or an alternative for Windows users), and cloned the repo, you can run hugo serve. At this point, you can surf your website from a browser at: http://localhost:1313/.
When you commit changes to the main branch, a job (which runs using Github Actions) will build a new copy of your website and publish it on Github Actions. You might need to check the repo settings (under the 'Pages' tab).
In the content/ folder you can find several markdown files. _index.md would be your homepage. Therefore, you are free to create new markdown files. You need to make sure to include these fields in the beginning of your file:
---
title: Page title
prev: link-prev-page
next: link-next page
---Whereas, prev and next are the link to the pages displayed at the bottom of the page. If omitted, no link is going to be displayed!
Please, check the examples provided and the source code. By using Markdown you will be able to include:
- Formatted text (bold, italic)
- Images
- Tables
- Math formula
- Code
- Quotes
- Lists
The config.toml file contains many variables related to your project. Here you can update much information such as: Project title, Authors, Links, Navbar. The changes are propagated and displayed automatically on every page you've created.
Make sure to update the baseUrl variable! This variable is extremely important for publishing the website on Github Pages. The variable should follow this format https://<github_username>.github.io/<repo_name>.
Images and other files can also make public together with the website. They must be stored in the static/ folder. You may find already the DTU logo saved there. Also, you can export your Jupyter notebook and save it as an HTML file (File > Export Notebook as > HTML) and save it there. This way you can publish your code.
At every change committed to the main branch a job running using Github Actions will build and deploy your website on Github Actions. The job workflow is written in YAML, you shouldn't need to apply any changes. It is triggered every time a new commit is pushed to the main branch, and it builds and publishes a new version of the website on the gh-pages branch.
The website URL is going to be live at: https://<github_username>.github.io/<repo_name>.
Please make sure to check the repository settings, you would need to enable Github Pages: Settings > Pages. In Source select gh-pages as branch and keep / (root) as directory. Click on Save 😉
This template has been built on top of Minimal Blog and wrapped into a Hugo website.
Some of the technologies used are: