This is the main branch for the CUDAN website. You need to be a collaborator to edit and add files. Changes will automatically render the static webpage into the gh-pages branch. Do not touch the gh-pages!
The CUDAN webpage is based on the following:
Hugo: https://github.com/gohugoio/hugo
Book theme: https://github.com/alex-shpak/hugo-book
Makdown language: https://www.markdownguide.org/
On top of the Hugo Book Theme, the CUDAN webpage uses custom html code in the layouts folder (e.g. shortcodes). Additional styling was also added to "themes/book/assets/_custom.scss". Be aware that changing the theme will require to tranfer/adjust some of the CSS from this file to the new theme styling.
A GitHub Actions worklow file (.github/workflows/gh-pages.yml) renders the static pages automatically into the gh-pages branch, every time a commit is executed. Read more about GitHub Actions here: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
https://gohugo.io/getting-started/installing/
IMPORTANT! Pushing your content overrides the whole public webpage! This means you always need to pull origin of the main branch first to make sure you are updating the latest version (if you are using git from your local machine). Never commit to the gh-pages branch directly! Use the main branch instead. You don't need to render the webpage locally – the static page will be rendered automatically with every commit (see GitHub Actions in .github/workflows/gh-pages.yml).
Every event is a file by its own inside the events folder. For consistency, filenames should start with the date followed by a clear title as in: 2021-02-08-deb-verhoeven-cudan-lecture.md
Please use the example file event-example.md in the examples folder as reference: https://github.com/cudanlab/cudanlab.github.io/blob/main/examples/event-example.md
IMPORTANT! In the header of a new event file, define a start and end date for the events parameter in the following format:
---
events:
start: 2021-02-08T14:00:00-00:00
end: 2021-02-08T16:00:00-00:00
The event title follows the format:
title: "Speaker Name - Title of Talk"
---
Don't use nested quotation marks inside the title (this will result in an error notification email and not update the webpage).
Put the abstract text and other additional information that should be hidden in the events page list after the "more" tag:
<!--more-->
**Abstract** - Abstract text goes here.
Always use your own GitHub account when committing changes. The safest method for editing existing content or adding new events is to stay in the GitHub browser and stay only in this directory: https://github.com/cudanlab/cudanlab.github.io/tree/edit/content
If you want to use git from your local machine, always pull origin fromt he main branch before committing!
These are the elements outlined in John Gruber's original design document. All Markdown applications support these elements.
| Element | Markdown Syntax |
|---|---|
| Heading | # H1 |
| Bold | **bold text** |
| Italic | *italicized text* |
| Blockquote | > blockquote |
| Ordered List |
1. First item |
| Unordered List |
- First item
|
| Code | `code` |
| Horizontal Rule | --- |
| Link | [title](https://www.example.com) |
| Image |  |
These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.
| Element | Markdown Syntax |
|---|---|
| Table |
| Syntax | Description | |
| Fenced Code Block | ``` |
| Footnote |
Here's a sentence with a footnote. [^1] |