|
| 1 | +# Fast ML Lab Website Insructions |
| 2 | +This website is built on Github Pages using Jekyll, and thus, editing raw HTML should be unneccessary for most content updates. |
| 3 | + |
| 4 | +## Add a News Item |
| 5 | + |
| 6 | +Create a file `_posts/yyyy-mm-dd-title.md` and add the following at the beginning: |
| 7 | + |
| 8 | +```yaml |
| 9 | +--- |
| 10 | +title: HLS4ML |
| 11 | +external_link: https://fastmachinelearning.org/hls4ml/ |
| 12 | +layout: post |
| 13 | +description: 'hls4ml: an open-source code framework for translating machine learning algorithms directly into FPGA firmware' |
| 14 | +image: /images/hls4ml.png |
| 15 | +--- |
| 16 | +``` |
| 17 | + Note that file paths for images should include a leading `/` to indicate an absolute path from the root of the site. Putting quotes around the title/description (single or double) is reccomended to avoid issues with yaml parsing. You can also add markdown content following this header and it will render as a complete web page, but as of yet there is no link to this post displayed on the front page, only content from the header. This may change in the future. |
| 18 | + |
| 19 | + |
| 20 | +## Add a Person |
| 21 | +In the file `_data/people/institution_name/lastf.yml` include the following: |
| 22 | +```yaml |
| 23 | +name: First Last |
| 24 | +degree: Degree |
| 25 | +field: Field |
| 26 | +position: Current Position at Institution |
| 27 | +interests: List of Interests |
| 28 | +image: /images/lastf.png |
| 29 | +external_link: http://your.url.here/ |
| 30 | +``` |
| 31 | +Note that the Jekyll site is set up to generate and alphabetize the institution list based on the folder names on the fly, interpreting an underscore in the directory name as a space. Therefore, if adding someone from a new institution, just add a new folder for their institution and place the person's info file inside. Note that file paths for images should include a leading `/` to indicate an absolute path from the root of the site. |
| 32 | + |
| 33 | +## Add a Paper |
| 34 | +Add papers to the yaml list in `_data/papers.yml` |
| 35 | + |
| 36 | +Note that this will render markdown syntax. Putting quotes around the title (single or double) is reccomended to avoid issues with yaml parsing. |
| 37 | + |
| 38 | +**Example:** |
| 39 | +```yaml |
| 40 | +- 'Real-time Artificial Intelligence for Accelerator Control: A Study at the Fermilab Booster, [arXiv:2011.07371](https://arxiv.org/abs/2011.07371).' |
| 41 | +``` |
| 42 | + |
| 43 | +## Add a Talk |
| 44 | +Add talks to the yaml list in `_data/talks.yml` |
| 45 | + |
| 46 | +Note that this will render markdown syntax. Putting quotes around the title (single or double) is reccomended to avoid issues with yaml parsing. |
| 47 | + |
| 48 | +**Example:** |
| 49 | +```yaml |
| 50 | +- "C. Herwig, An ML Control System for the Fermilab Booster, BIDS Machine Learning and Science Forum, April 2021, [abstract](https://bids.berkeley.edu/events/machine-learning-and-science-forum-2021-0405)" |
| 51 | +``` |
| 52 | + |
| 53 | +## Add a Sponsor |
| 54 | +Add sponsors to the yaml list in `_data/sponsors.yml` |
| 55 | + |
| 56 | +Note that this will **not** render markdown syntax. Entries for both `name` and `image` fields are required (see example). Note that file paths for images should include a leading `/` to indicate an absolute path from the root of the site. |
| 57 | + |
| 58 | + |
| 59 | +```yaml |
| 60 | +- name: National Science Foundation |
| 61 | + image: /images/nsf.png |
| 62 | +``` |
0 commit comments