This is not supported anymore. Please use https://designsystem.gov.au
Below is for archive purpose only:
How to use the UI-Kit CSS framework to build accessible and usable sites.
Development dependencies:
- Ruby (= 2.3.1)
- jekyll (= 3.3.1)
- Node (>= 6)
Clone the repo:
git clone https://github.com/AusDTO/dto-design-guide.git
git submodule init
git submodule updateInstall dependencies and set up project:
cd dto-design-guide
bundle install && yarnTo generate the uikit.json and move the template files run this.
(You only have to run this once after initial pulling or after the submodule version has changed)
npm startFire up Jekyll:
jekyll serve --watch --incrementalOpen the site at http://127.0.0.1:4000/
This guide includes the UI-Kit as a
git submodule to _assets/vendor/dto-ui-kit.
├── _assets
│ └── vendor
│ └── dto-ui-kit
The node script in ./generate-json.js will be run with npm start and extracts out all template files and puts them into the _includes/templates folder
for jekyll to reuse. The script also generates the _data/uikit.json after it parses the ui kit via KSS.
├── _data
│ └── uikit.json
├── _includes
│ └── templates
Open an issue first to discuss potential changes/additions. We encourage you to read our Contributor Code of Conduct. By ensuring that all contributors follow this guide we can maintain an inclusive and friendly community.
© Copyright Commonwealth of Australia.
With the exception of the Commonwealth Coat of Arms and where otherwise noted, this work is licensed under the MIT license.