Skip to main content
Table of contents

Create a new documentation project

  1. Open the command line interface.

  2. Navigate to your documents folder.

  3. Run the following in the command line:

    middleman init PROJECT_NAME -T alphagov/tech-docs-template
    

    where PROJECT_NAME is the name of your project.

  4. Answer the installation questions.

  5. Project creation is complete when you see Bundle complete!.

Configure your new documentation project

Enable collapsible navigation

Add the following code to your project’s tech-docs.yml file if necessary:

# Enable collapsible navigation in the sidebar
collapsible_nav: true

The search function is especially useful for multipage documentation.

Add the following code to your project’s tech-docs.yml file if necessary:

# Enable search
enable_search: true

View your new documentation project

Navigate to the created documentation repo folder.

The folder will have multiple pre-populated files. You will only need to amend the /source folder and the config/tech-docs.yml file.

This page was last reviewed on 3 October 2019. It needs to be reviewed again on 4 October 2019 by the page owner #docs-repos .
This page was set to be reviewed before 4 October 2019 by the page owner #docs-repos. This might mean the content is out of date.