Tech docs template Beta
Table of contents

Create a new 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!.

View your new 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.