search

AusDTO / gov-au-content-guide

The draft previous version of the GOV.AU Content Guide. We have moved:
https://github.com/govau/content-guide
Creative Commons Attribution 4.0 International
3 stars 6 forks source link

readme

Draft Content Style Guide

This guide is designed to help people working in the Australian Government create simpler, clearer and faster information.

It can be currently accessed at http://content-style-guide.apps.staging.digital.gov.au/

Status: the guide is in active development.

Feedback

You can leave feedback to the guide in numerous ways:

  1. via the email feedback buttons and links in the guide (Please join our Content Design in Government Google Group to give feedback)
  2. via GitHub issues.

Editing the guide

The guide is setup to provide access directly to the content of the guide via prose.io.

To access and edit the guide go to prose.io and sign in via your GitHub account.

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.

We will document the ui-core and guides-specific styles available later.

Please save into the content-editing branch (right-hand sidebar within prose).

Developer information

This guide is built with Jekyll.

Development status

This guide includes currently three projects that have not yet been refactored into separate repositories:

  1. ui-core: a series of scss files
  2. gov-au-guide-template: a content-agnostic Jekyll theme for holding and building the gov.au guides
  3. gov-au-guide-content: the gov.au content guide (data held in this repository; yet to be renamed)

Setup

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 via Prose.io. 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.

The Design Guide uses Jekyll. We use rbenv to manage Ruby and RubyGems.

Requirements

Setup locally

git clone https://github.com/AusDTO/gov-au-content-guide.git
cd gov-au-content-guide
gem install bundler
bundle install

Launch locally

bundle exec jekyll serve

If you get gem errors, try

rbenv rehash

If you still have troubles contact a dev!

Copyright & License

Copyright Digital Transformation Office. Licensed under the Creative Commons Attribution 4.0 International Public License. See LICENSE file for more details.

About the DTO

The GOV.AU Content Guide is maintained and funded by the Digital Transformation Office.