- Prerequisite: install hugo (https://gohugo.io/getting-started/installing/) if you want to see and test the changes locally
- Clone repository and submodules:
- (HTTPS)
git clone --recurse-submodules https://github.com/IEEE-SaTML/ieee-satml.github.io.git - (SSH)
git clone --recurse-submodules [email protected]:IEEE-SaTML/ieee-satml.github.io.git
- (HTTPS)
The theme used by the SaTML website is a fork of the Syna Theme that has been slightly modified. The theme is a git submodule cloned under themes/syna.
The file config.toml contains the main configurations (URL, title, favicon, colors, menus) for the SaTML website.
The folder content is composed of different subfolders, each one of these subfolders corresponds to a page of the website. A page is made up of fragments; each fragment is defined by a Markdown file (refer to content for examples), note that the weight attribute determines the order in which the fragments are arranged. See the Syna Theme Documentation for the different fragments that are available.
Fragments placed in the _global subfolder are applied to every page of the website (header, foother, menu, etc.), the _index subfolder corresponds to the Home page.
The folder resources is populated by the hugo server -D command when locally building and viewing the website during development.
The folder static contains the favicon, images, and some custom CSS for the website.
We use the following component.
Here is the corresponding README for that template:
A simple template that lets you display events on a timeline, as well as organize them in groups (week days, conference rooms etc…).
This experiment is built upon the CodyHouse Framework.
Make sure to include both the style.scss and util.js files of the framework.
(Addded note by Yohan: .scss deleted as not needed)
- Clone this repository
- Make your edits in the template files
- View your edits locally with
hugo server -D - Once satisfied, commit and push your edits to Github
- At every new commit pushed to the
mainbranch on Github, a Github Action is triggered to rebuild and redeploy the website automatically (no need to run thehugocommand yourself or create apublicfolder anymore)