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

• Install the Hugo extended version from the latest releases page

  • Ensure that you have the extended version

• Clone this repository locally:

  git clone https://github.com/2i2c-org/2i2c-brochure
  cd 2i2c-brochure
  

• The content for this site lives in content/. Each folder inside is a page.

• These folders have a collection of markdown snippets that are stitched into a single page.

  • Their order is determined by the weight: metadata on each page.

• Preview the site locally with:

  hugo serve -D
  

• Push your changes to the repository and Netlify will automatically update the website.

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.

Our blog post feed is at https://2i2c.org/posts/, and contains a feed of posts from 2i2c team members.

This feed contains both internal and external blog posts. In general, when team members do work associated with other open source projects, we should write those posts in other spaces and cross-link them from the 2i2c blog.

The way to make a regular blog post is by following the standard Hugo documentation for internal blog posts. Check out the WowChemy theme documentation for one way to do this.

To make an external blog post, follow these steps:

• Generate a blog post folder and include a markdown file similarly to how you'd generate an internal blog post.
• Add an external_link metadata parameter at the top of the file. The value of this parameter will be the external link the post should point to.
• All other metadata can be the same, and will be used to share the post author, published order, etc.

Featured images are displayed to the right of each post in our post feed. By default, you can add a featured image directly to the blog post's folder by adding an image called featured*. For example, featured.jpg, featured-image.png, etc.

If you'd like to re-use another image on the site, you can create a symbolic link from the post folder to the image you'd like to re-use. This helps us save space and load time.

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