The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
npm ci in this repository rootbundle install in this repository rootnpx gulp watch in this repository root to deploy a live server to http://localhost:4000Dev deployment target: https://ucsd-e4e.github.io/website2.0/
npx gulp build performs a single static build of the sitenpx gulp build -j "<INSERT JEKYLL ARGS>" creates a build of the site with custom jekyll arugments@Book@PhdThesis with type set to PhD Thesis@MastersThesis with type set to MS Thesis@Patent with number set to the full US Patent number (e.g. US0123456789)@InBook@InProceedings@Articleurl field.preprint field..bib file and push to main- project: {project_name}
location: {expedition_location}
date: {YYYY-MM}
year: {YYYY}
month: {MMMM}
lead:
- {lead1}
- {lead2}
people:
- {member1}
- {member2}
- {member3}
# below fields are optional
link: {URL to blog post/news about expedition}
media:
- {public links to published image/video galleries}
data:
- {links to dataset, can be private}
properties:
# for internal use only, see developers for more information.yml file and push.Images MUST be placed in the following location: /assets/{project}/
Images SHOULD be named YYYY-MM-DD_description_of_image.ext. If a date is not relevant (for example, a logo), then the date may be omitted.
Images SHOULD be placed in the markdown using the following: {{ relative_path_to_image_from_assets | resize: final_size,webp,80 | absolute_url }}. See https://imagemagick.org/script/command-line-processing.php#geometry for a full description of the resize argument.
To make a section for a project, one must do the following:
projects/projects.md add a new json object to the blurbs array. This looks like:
- photo: "assets/projects-new_project-photo.png"
text: "Description of project"
project_name: "Name of Project"
link: "/insert-project-link"Where photo is the filepath to the project's blurb photo, text is a short description of the project, the project_name is the name of the project, and link is the path in the url the project will live
insert_name_of_project.md. At the top add the following head:
---
layout: project
permalink: /insert-project-link
title: Name of Project
category: project-categories
enable_nav: false
---Where permalink is the same value as link in projects.md, title is whatever you want to call the project, category is the tag representing your project (note: this should be the category used in future news posts associated with the project)
Set enable_nav to false for now and you have the mimumum needed to start creating your project
Some projects have the added feature of including a news feed containing posts about that project and a gallery to show up some important photos from diffrent events in the project. To add these pages do the following:
insert_name_of_project-media.md and insert_name_of_project-updates.mdinsert_name_of_project-media.md add the following:
---
layout: gallery
permalink: /insert-project-link
title: Name of Project
category: project-categories
enable_nav: true
grid: true
media:
- assets/project-photo-1.png
- assets/project-photo-2.png
- assets/project-photo-3.png
- ...
---Here there are two new paramters that diffrent from insert_name_of_project.md. ALL OTHER PARAMETERS SHOULD BE IDENTICAL TO insert_name_of_project.md
Your gallery page on the website will be found at /insert-project-link/media
insert_name_of_project-updates.md and add the following text at the top of the file:Fill in permalink, title, and category with the same values used in the respective variables for insert_name_of_project.md and insert_name_of_project-media.md. Keep layout as post_feed.
Your post feed page on the website will be found at /insert-project-link/project-updates
_bibliography/onboarding_papersonboarding_papers.md, add the following to the front matter's paper list:url MUST be the same as permalink on your project
Jeykll allows for components to be embedded in markdown files. See https://jekyllrb.com/docs/includes/
Up to 3 images can be place in a row with a caption below the image with text centered. The number of images placed depends on number of src paramters passed. Note if you are using only 2 images, src3 will have no effect and if you are only using 1 image, src2 and src3 will have no effect.
Params:
Format: {% include img_caption.html src="/abs/path/to/source/1" src2="/abs/path/to/source/2" src3="/abs/path/to/source/3" caption="Text to include" %}
Creates a photo gallery in the page. This can be either in a grid format where all images are set to 200 by 200 photos with cropping, or not grid where the images attempt to maintain thier full size and aspect ratios.
Gallaries require passing in a list of images. Liquid doesn't allow for directly creating the list in the includes statement. To make a list of images you can put the list into the yaml section of the markdown file and access the files through there. For example
---
layout: gallery
permalink: /acoustic-species-identification/media
title: Acoustic Species Identification
category: acoustic-species-identification
enable_nav: true
grid: true
media:
- assets/acoustic_species_id/white_winged_becard_vocalization.png
- assets/acoustic_species_id/2021-08-04_scripps_coastal_reserve_trail.jpg
- assets/acoustic_species_id/2021-08-10_audiomoth.jpg
- assets/acoustic_species_id/2021-08-10_mugen_blue_looking_at_audiomoth.jpg
- assets/acoustic_species_id/2021-08-10_jacob_placing_audiomoth.jpg
- assets/acoustic_species_id/2021-08-10_expedition_team.jpg
- assets/acoustic_species_id/2021-08-04_jacob_searching.jpg
- assets/acoustic_species_id/audiomoth_acoustic_array.png
---The images will be accessed through page.media
Params:
Format: {% include gallery_component.html media=page.media grid=true %}
ONLY USED FOR PROJECT LAYOUTS. MUST NOT BE USED IN MARKDOWN FILES.
Creates the nav bar for project pages, namely the main project make, the project's update page, and the project's gallery page.
Params:
Format: {% include project_navigation.html title="INSERT TITLE" url=project_url enable_nav=true or false %}
Create a new file in /_posts with the following name: {year}-{month}-{day}-{hyphenated-title}.md. For example: 2024-05-10-e4e-releases-new-jekyll-website.md.
At the top of the file, add the following:
---
date: {year}-{month}-{day} {hour}:{minute}-{timezone offset}:00
layout: blog-post
title: {title}
categories:
- news-and-updates
author: {your name}
featuredImage: {relative path to featured image}
tags:
- {additional tags}
---For example:
---
date: 2024-05-07 21:45-07:00
layout: blog-post
title: Ronan Wallace Awarded Fulbright for Floods of Lubra
categories:
- news-and-updates
author: Nathan Hui
featuredImage: assets/floods_of_lubra/fieldwork-nepal.jpg
tags:
- floods-of-lubra
- fulbright
---Add the contents of your blog post after this preable, using the appropriate components.
Commit this and any included images to a new branch (we recommend using the same format as the blob post file name). Request a review from one of the website admins and enable auto merge.
- project: {project_name}
title: {position title}
description: {multiline string describing project and position}
required: {optional list of required skills}
desired: {optional list of desired skills}
link: {optional link to project webpage}For example:
- project: Radio Telemetry Tracker
title: Lead
description: |
This is a multiline project description.
This is still part of the position description, and includes a blank line between the previous line.
desired:
- Desired skill 1
- Desired skill 2
required:
- required skill 1
- required skill 2
link: /radio-collar-tracker