Website

Made with Hugo with the Syna theme.

This is the repository containing the markdown files, Hugo configurations, and deploy shell script. For the hosted HTML, CSS, and JS, see the other repository

How to update

1. Clone this repository

git clone https://github.com/ADC-UMN/site.git

2. Test the website out locally

cd site
hugo server # see http://localhost:1313 in your browser
# Ctrl + C to kill the server

3. Remove the public directory

rm -rf public

4. Create a git submodule

git submodule add -b master https://github.com/ADC-UMN/ADC-UMN.github.io.git public

Now when you run the hugo command to build the site to public, the created public directory will have the aforementioned other repository as its remote origin instead of this repository.

4. Make changes to the content

Focus on the content directory, which has the markdown files for the site. It has this structure:

content/
+--_global/ # appears on every page
|  +--copyright.md
|  +--footer.md
|  +--index.md
|  +--nav.md # top navigation bar
+--_index/ # content for the main page at '/'
|  +--about/ # about section
|  |  +--content.md
|  |  +--index.md
|  +--coding/ # coding section
|  |  +--index.md
|  +--hero/ # hero immediately below the navigation bar with the buttons and particle effects
|  |  +--config.json
|  |  +--index.md
|  +--network/ # network section
|  |  +--index.md
|  +--speakers/ # speakers section
|  |  +--index.md
|  +--index.md
+--board/ # content for the page at '/board'
|  +--_index/
|  |  +--name1.md
|  |  +--name2.md
...
|  +--index.md
+--meetings/ # content for the page at '/meetings'
|  +--_index/
|  |  +--fall.md # fall semester event calendar as a table
|  |  +--index.md
|  |  +--spring.md # spring semester event calendar as a table
|  +--index.md
+--_index.md

5. Commit and push changes

git add .
git commit -m 'a descriptive message'
git push

6. Run the deploy script

./deploy.sh 'a descriptive message'