This repository has been archived by the owner. It is now read-only.
- DEPRICATED - Please see:
CSS Liquid JavaScript Ruby Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
_assets
_components
_data
_foundations
_getting-started
_includes
_layouts
_patterns
_plugins
_templates
bin
images/uikit/icons
.editorconfig
.gitignore
.gitmodules
.ruby-version
Gemfile
Gemfile.lock
LICENSE.md
README.md
Rakefile
_config-develop.yml
_config-production.yml
_config.yml
android-chrome-192x192.png
android-chrome-512x512.png
apple-touch-icon.png
browserconfig.xml
circle.yml
config.ru
favicon-16x16.png
favicon-32x32.png
favicon.ico
generate-json.js
index.md
manifest-develop.yml
manifest-production.yml
manifest.json
manifest.yml
mstile-150x150.png
package.json
safari-pinned-tab.svg

README.md

== DEPRICATED ==

This is not supported anymore. Please use https://designsystem.gov.au

Below is for archive purpose only:

DTA Design Guide

Build passing/failing license link Latest release

How to use the UI-Kit CSS framework to build accessible and usable sites.


Table of contents

  1. Development
  2. Contributing
  3. Copyright & license

Development

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 update

Install dependencies and set up project:

cd dto-design-guide
bundle install && yarn

To 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 start

Fire up Jekyll:

jekyll serve --watch --incremental

Open the site at http://127.0.0.1:4000/


Updating content from UI-Kit

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

Contributing

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 & license

© 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.