- Basic Style Guide
- Contribution Guide
- Creating a team member profile
- Creating content e.g. page/blog/casestudy
- Syntax Highlighting Code in Blogs
- SCSS/CSS filenames should be kebab case (i.e.
kebab-case) to match class names. - Assume that each parent "component" should have it's own corresponding stylesheet. E.g. The
.about-pageclass declaration can be found in the_about-page.scssfile - A parent "component" will be named with two words, separated by a hyphen. E.g.
.service-list - A child "component" will be named with one "word", no hyphens. E.g.
.serviceitem - Some out-dated classes probably exist that don't follow this convention, so those should be refactored.
JavaScript filenames should be camel case (i.e. camelCase) to match the JS object/method naming conventions.
HTML/Jekyll templates should be snake case (i.e. snake_case) to match Jekyll/Ruby conventions.
- Clone this repo
- Ensure that
dockeris running - Run
docker-compose up
Note: if you don't see your changes showing up, stop the jekyll server, do a jekyll clean then start the server again.
You may find reading about Jekyll will help also.
This section provides a summary of the ways different types of content can be added.
- Take a profile photo. Visit our Team Profile Photo Guide to see how
- Add your details in
/data/people.ymlfile - Ensure your photo is of the same dimensions as the others and put it in the
/assets/img/teamfolder. The filename should match thepicvalue you provided with your details above - Check that it looks good in the browser
- Open a PR and request a review
- Add your new page in the
/pagesdirectory - Make sure to set the
permalinkof the page in the frontmatter - Add the page link to the top navigation
- Copy an existing post in the
blog/_postsdirectory, edit the file name and "front matter" accordingly - Get your markdown on
- Review in the browser when done writing
- Open a PR and request a review
- Copy an existing post in the
_case_studies/directory, edit the file name and "front matter" accordingly - Create an
imgand athumbnailfor the new case study item in theassets/img/case-studiesdirectory - Review in the browser when done
- Open a PR
In your markdown, you can use a shortcode to add syntax highlighting to your code. Below is an example for JavaScript:
{%highlight javascript %}
function myCoolFunc() {
let hello = "uh, hello";
alert(hello);
}
myCoolFunc();
{% endhighlight %}