Before you start
To use the Tech Docs Template you need:
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:
Preview your changes locally
To preview your new website locally, navigate to your project folder and run:
bundle exec middleman server
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
If you make changes to the
config/tech-docs.yml configuration file, you need to restart Middleman to see the changes.
Publish your changes
Travis CI automatically publishes changes merged into the master branch of this repository.
bundle update to make sure you're using the most recent Ruby gem versions.
bundle exec middleman build --verbose to get detailed error messages to help with finding the problem.
Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.