Skip to content

Commit

Permalink
Merge pull request #144 from alphagov/trim-readme
Browse files Browse the repository at this point in the history
Remove tdt docs content from readme file
  • Loading branch information
jonathanglassman authored Feb 24, 2021
2 parents 6db8380 + 22381ef commit 3f13e6c
Showing 1 changed file with 2 additions and 43 deletions.
45 changes: 2 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,59 +4,18 @@

This repository is used to generate the [documentation website for the Tech Docs Template][tdt-docs] and uses the template itself.

The Tech Docs Template is a [middleman template][mmt] that
you can use to build technical documentation websites using a GOV.UK style.

## Before you start

To use the Tech Docs Template you need:

- [Ruby][install-ruby]
- [Middleman][install-middleman]

## Making changes

To make changes to the documentation for the Tech Docs Template website, edit files in the `source` folder of this repository.

You can add content by editing the `.html.md.erb` files. These files support content in:

- Markdown
- HTML
- Ruby

👉 You can use Markdown and HTML to [generate different content types][example-content] and [Ruby partials to manage content][partials].

👉 Learn more about [producing more complex page structures][multipage] for your website.

## Preview your changes locally

To preview your new website locally, navigate to your project folder and run:

```sh
bundle exec middleman server
```

👉 See the generated website on `http://localhost:4567` in your browser. Any content changes you make to your website will be updated in real time.

To shut down the Middleman instance running on your machine, use `ctrl+C`.

If you make changes to the `config/tech-docs.yml` configuration file, you need to restart Middleman to see the changes.

## Publishing changes

Travis CI automatically publishes changes merged into the master branch of this repository.

## Troubleshooting

Run `bundle exec middleman build --verbose` to get detailed error messages to help with finding the problem.

## Code of conduct

Please refer to the `alphagov` [code of conduct](https://github.com/alphagov/code-of-conduct).
Refer to the `alphagov` [code of conduct](https://github.com/alphagov/code-of-conduct).

## Licence

Unless stated otherwise, the codebase is released under the [MIT License](LICENSE). This covers both the codebase and any sample code in the documentation.

The documentation is [© Crown copyright](http://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/copyright-and-re-use/crown-copyright/) and available under the terms of the [Open Government 3.0 licence](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).

[mmt]: https://middlemanapp.com/advanced/project_templates/
Expand Down

0 comments on commit 3f13e6c

Please sign in to comment.