This guide is designed to help people working in the Australian Government create simpler, clearer and faster information.
Live site: https://guides.service.gov.au/content-guide/
Staging site: https://content-guide.apps.staging.digital.gov.au/
You can leave feedback to the guide in numerous ways:
- via the email feedback buttons and links in the guide (Please join our Content Design in Government Google Group to give feedback)
- via GitHub issues.
ToDo: add useful information here :)
To mark-up your content, write in Markdown. We use the 'kramdown' (default) markdown parser, which provides a couple of extra features. For a reference on what's possible see the kramdown quick reference.
This guide is built with Jekyll.
You would only need to do the following if you are a developer. If you are a content editor you can access and editing content for the guide directly via GitHub. However, it can be nice having the guide locally to work and preview --- feel free to ask a developer if you would like to set up a local instance of the guide.
There is also a simpler guide in the README of the service-handbook project which might be useful to incorporate here.
- Ruby
- Jekyll
We also pull in the 1.x version of the UI-Kit as a submodule.
We will likely change this, and instead package up everything needed to produce a new guide scaffold as a Ruby gem for Jekyll to consume.
Setup locally
git clone git@github.com:govau/content-guide.git
cd content-guide
git submodule init
git submodule update
gem install bundler
bundle install
Launch locally
bundle exec jekyll serve
If you get gem errors, try
rbenv rehash
If you still have troubles ask for help! (:
Internal links are tested as part of the CI build pipeline in bin/citest.sh, however to keep test results reproducible external links are skipped.
You should periodically manually test external links with:
bin/checkexternal.sh
Copyright Digital Transformation Agency. Licensed under the Creative Commons Attribution 4.0 International Public License. See LICENSE file for more details.
The GOV.AU Content Guide is maintained and funded by the Digital Transformation Agency.