https://github.com/dvsa/mot-docs
Web based technical documentation for the MOT service
https://github.com/dvsa/mot-docs
Last synced: about 1 year ago
JSON representation
Web based technical documentation for the MOT service
- Host: GitHub
- URL: https://github.com/dvsa/mot-docs
- Owner: dvsa
- Created: 2017-04-19T13:51:09.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-11-24T06:40:01.000Z (over 8 years ago)
- Last Synced: 2025-02-08T22:28:34.717Z (over 1 year ago)
- Language: CSS
- Size: 6.42 MB
- Stars: 0
- Watchers: 6
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Technical Documentation
## Getting started
To preview or build the website, we need to use the terminal.
Install Ruby with Rubygems, perferably with a [Ruby version manager][rvm],
and the [Bundler gem][bundler].
In the application folder type the following to install the required gems:
```
bundle install
```
## Making changes
To make changes edit the source files in the `source` folder.
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
`source/documentation`.
A new markdown file isn't automatically included in the generated output. If we
add a new markdown file at the location `source/documentation/agile/scrum.md`,
the following snippet in `source/index.html.md.erb`, includes it in the
generated output.
```
<%= partial 'documentation/agile/scrum' %>
```
Including files manually like this lets us specify the position they appear in
the page.
## Preview
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.
## Build
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.
[rvm]: https://www.ruby-lang.org/en/documentation/installation/#managers
[bundler]: http://bundler.io/