This repository contains all the source materials for ML4Health Symposium and NuerIPS ML4Health workshop website.
Creating new folder for a new year
- Copied the
2021_contentto2022_content. - Edit homepage in
2022_content/pages/00_index.md. Change the date, announcements, and sponsor, as appropriate. - Update information in
2022/index.html. Remove tabs for which information is currently unavailable e.g., speakers, schedule, etc. (You can add later). - Change year in
Makefile. Change link in./index.html. Switch years inpelicanconf.py
Creating new folder for a new year
- Copied the
2020_contentto2021_content. - Edit homepage in
2021_content/pages/00_index.md. Change the date, announcements, and sponsor, as appropriate. - Update information in
2021/index.html. Remove tabs for which information is currently unavailable e.g., speakers, schedule, etc. (You can add later). - Change year in
Makefile. Change link in./index.html. Switch years inpelicanconf.py
Creating new folder for a new year
- Copied the
2019_contentto2020_content. - Alter in
Makefileto put to year 2020. Change link in./index.html. Switch years inpelicanconf.py - Edit homepage in
2020_content/pages/00_index.md. Remove pages you don't need right now. You can always recopy them from2019_content - Website should initially have dates, schedule, speakers, and organizers. Add call for papers when ready.
Editing an existing page
- Make edits on page in
2020_content/pages/ make htmlin root.make serveto check it looks fine. Then push to public.
Adding a page from the 2018 website
- Copy over the page from
2018_content/pages/.to2019_content/pages/. - If the page looks "complicated", check and see if there is a corresponding
make organizersor something else in theMakefile. In that case, you're meant to update the corresponding csv first and then runmake organizersormake accepted_papers. This will generate the static page from the input files. make htmlin root.make serveto check it looks fine. Then push to public.
- Want to change the order of pages in toolbar? Alphabetical by page filename, but make title in page the actual thing you want.
- Images for organizers or speakers looking strange? Make sure all of the captions are the same length (same number of lines), otherwise it will throw off the spacing.
$ make organizers # Build the organizers page from .csv file of raw data
$ make html # Build static site on local machine under 2018/ output folder
$ make serve # Serve website locally. Point browser to: localhost:8000
To push any local changes to the real site, just push to origin (assuming origin = github.com/ml4health/ml4health.github.io)
$ git push origin master
Remember, only content that you've turned into proper HTML files inside 2017/ with make html will be displayed on the website. Edits to the markdown source files in 2017_content/ do not automatically become html when pushed.
Hint: Adjust SITEURL inside pelicanconf.py to get links right when building locally.
- Pelican: http://blog.getpelican.com/
- Markdown
$ conda install -c conda-forge pelican=3.7.0
$ conda install markdown
$ pip install pelican
$ pip install markdown
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -r requirements.txt
All the 2017 Makefiles, etc are preserved in the "release_v2017" branch.
$ git checkout release_v2017
$ make organizers # Build the organizers page from .csv file of raw data
$ make html # Build static site on local machine under 2017/ output folder
$ make serve # Serve website locally. Point browser to: localhost:8000
Uses custom theme already included in repo (themes/customized-pelican-alchemy/)
Based on Pelican-Alchemy (https://nairobilug.github.io/pelican-alchemy/)
- Resized header so logo is smaller (2 cols in bootstrap, not 4).
- Removed "Archives" and "Categories" menu items (this site wont have "posts", just "pages")