DCgov Guides Template

Introduction

Introduction

The template is derived from CFPB/DOCter and 18F/guides-template. It uses Jekyll as the rendering engine.

DCgov guides sites are intended for documenting best practice standards (e.g. design, accessibility, analytics, licensing). They may also be used to provide background information on project repositories, but you really should try to do so in your repository’s README file. 18F’s open source style guide provides excellent advice for making your projects easy to use and understand!

Create a new guide

To get started on a new guide, follow the “Getting started” instructions in the DCgov/guides-template GitHub repository to create a local clone of this template.

Once you’ve created a clone, click the Add a New Page entry in the table of contents to begin the rest of the steps.

Close

Glossary of Terms

  • A glossary term

    To add glossary terms, edit the glossary.yaml file in the _data folder.

  • Another term

    Glossary terms need a term, slug, and definition attribute. The term attribute will appear above the definition. The slug is a unique identifier for the term. It should be lowercase, with no special characters or punctuation, and any spaces replaced with a dash.

  • Yet another term

    Want to link to a specific glossary term in your text, like this one here? You will need to edit your markdown like so:

    [this one here](#glossary){:define="yet-another-term"}

    Just place the text you want linked in the brackets and the correct slug within the quotes.