Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 4.34 KB

README.md

File metadata and controls

97 lines (62 loc) · 4.34 KB

2i2c brochure

This is a brochure website for the International Interactive Computing Collaboration (2i2c). It is built from the academic hugo theme.

Where the website is hosted

This website is hosted by GitHub Pages, and we use Netlify to display previews of the website from PRs.

How to edit, build, and preview this website

See the Team Compass blog documentation for more information.

Website-specific features

Automatic GitHub link shortening

This theme will automatically shorten GitHub links and add a little GitHub icon to the front. For example, see the Jack Eddy Symposium blog post.

Broken link checking

We have a GitHub workflow to check for broken links. This runs each week and will open an issue if it finds any broken links.

Force a website re-build

To force a website re-build, trigger a workflow dispatch here.

Social media preview images

For text-based pages, we generate social media previews by automatically adding page title text to an image template. The template is defined in this Figma board and we use Hugo image filters to add text to it. See the hugo partial template we use for details and links.

The Featured Image will also be used to generate previews in social media. You can generate an image designed specifically for social media (similar to GitHub social media link previes). To do so, follow these steps:

  1. Go to this Figma project for a template.

  2. Find the "Twitter Summary Community Update" frame.

  3. Update the text to match the title of what you'd like to post.

  4. Export the frame to PNG (at 1x size).

  5. Place the PNG in the same folder as the relevant website page.

  6. Rename the image so that it is "featured" for that page (see above)

  7. Prevent the image from showing up on the page by adding the following to that page's YAML metadata:

    image:
  preview_only: true

The image will now be used to generate a social media preview!

Check the spelling of any pages

This repository is configured with the pyspelling package. It will analyze all of the markdown files in content/ and tell you if there are any un-recognized words.

To use pyspelling, first install it:

pip install pyspelling

Then install the aspell package:

sudo apt-get install aspell

Finally, you can run pyspelling on the repository like so:

pyspelling

Note that pyspelling may find some errors that are simply un-recognized, but correct, words. For example, HTML elements. To make these errors pass, you can add them to the list of custom spelling words here:

.custom-dictionary.txt.

For more information, see the pyspelling documentation.

Add a job post

We have some custom Hugo templates created for posting new jobs and a summary of open jobs.

  • The content/jobs/ folder contains all content related to job postings and an overview of working at 2i2c.
  • The /jobs/_index.md file is a "landing page" for our jobs (what is at 2i2c.org/jobs).
    • It contains a custom Hugo shortcode defined at layouts/shortcodes/open_jobs.html that will list all jobs in the jobs/ folder that have open: true in the page metadata.
  • Every other page in /jobs/ is a job posting. The YAML metadata at the top contains several important pieces of information for the job, and is used to populate job posting cards.
    • Use previous job postings as a reference for the information that should be used.
    • To mark a job as "open", make sure to put open: true in the posting metadata.
    • There's also a special shortcode to display relevant job metadata for a posting. This is at layouts/shortcodes/job_details.html.

This website's theme

We are using the latest version of the Hugo Blox theme (used to be the "Wowchemy Academic Theme"). See its documentation for information about customization and usage.