You can read documentation about the GDS technical documentation tool [external link].
To preview or build the website, we need to use the terminal.
In the application folder type the following to install the required gems:
To make changes edit the source files in the
Single page output
Although a single page of HTML is generated the markdown is spread across
multiple files to make it easier to manage. They can be found in
A new markdown file isn't automatically included in the generated output. If we
add a new markdown file at the location
the following snippet in
source/index.html.md.erb, includes it in the
<%= partial 'documentation/agile/scrum' %>
Including files manually like this lets us specify the position they appear in the page.
To add a completely new page, create a file with a
.html.md extension in the
source/about.html.md will be accessible on http://localhost:4567/about.html.
Whilst writing documentation we can run a middleman server to preview how the published version will look in the browser. After saving a change the preview in the browser will automatically refresh.
The preview is only available on our own computer. Others won't be able to access it if they are given the link.
Type the following to start the server:
bundle exec middleman server
If all goes well something like the following output will be displayed:
== The Middleman is loading == LiveReload accepting connections from ws://192.168.0.8:35729 == View your site at "http://Laptop.local:4567", "http://192.168.0.8:4567" == Inspect your site configuration at "http://Laptop.local:4567/__middleman", "http://192.168.0.8:4567/__middleman"
You should now be able to view a live preview at http://localhost:4567.
If you want to publish the website without using a build script you may need to build the static HTML files.
Type the following to build the HTML:
bundle exec middleman build
This will create a
build subfolder in the application folder which contains
the HTML and asset files ready to be published.
Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.