Skip to main content

Preview your documentation

You can start a local web server to preview your documentation site.

  1. Go to your project folder and run the following in the command line:

    bundle exec middleman server

    This will create HTML documentation files in the source/build folder, then start a local web server.

  2. Go to the local web server at http://localhost:4567/ to preview your documentation.

Press Ctrl-C in the command line to stop the web server.

You can also build your documentation to create HTML files without starting a local web server.

This page was last reviewed on 1 July 2021. It needs to be reviewed again on 1 July 2022 by the page owner #gds-technical-writing .
This page was set to be reviewed before 1 July 2022 by the page owner #gds-technical-writing. This might mean the content is out of date.