Please note: This repo is a work in progress, I've pushed it public for performance testing and feedback. Over the next week or so I will finalise the content in the /create and /about sections. Feel free to report any bugs or issues. Feedback welcome. Just remember it's not finished.
- breaking up
scratch.scssinto partials - updating documentation with front-matter templates and examples for contributors via github UI to work from
- updating documentation with front-matter templates and examples for contributors via jekyll to work from
- testing testing testing
There are two ways to contribute. You don't need to be able to code but you will need a (free) GitHub account in order to contribute.
Navigate to the _examples folder
Create new file
Paste in the example
Name the file giving it a .md file extension
Commit new file
Give a brief message, e.g. "Added example blah design principles"
Create a new branch (needs testing)
Create new pull request
Checkout the this repo and fire up jekyll (more instructions to follow in the next few days)
New features and improvements are welcome but please submit a discussion thread before you attempt or commit anything.
layout: ignore this
title: The title of this example, e.g. "The Five Principles of Design"
author: The company, team or individual that created these principles
link: A link to a source article or somehwere the original principles were created.
principles:
— principle: Each principle on a new line
tags: Add tags, separated by a comma. Tags aren't available on the site yet but will be soon. It's a good idea to add them in preparation. The proposed tags are:
OrganistionPersonalProductAIUXAccessibilityUniversalSpecific
Notes:
Troubleshooting - when bundle update throws An error occurred while installing commonmarker (0.17.6), and Bundler cannot continue. Make sure that `gem install commonmarker -v '0.17.6'` succeeds before bundling.
brew install cmake