Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-10 15:14:23 +00:00
Code Issues Projects Releases Packages Wiki Activity
inspec/www
History
Dominik Richter 98c8f35a60 switch to redcarpet for rendering 
to support proper markdown functionality, see github markdown for reference
2016-09-26 06:21:05 +02:00
..
data point download page to the right destination 2016-09-26 06:21:05 +02:00
lib introduce separate nav for docs in www/ 2016-09-26 06:21:05 +02:00
source update styling for docs 2016-09-26 06:21:05 +02:00
tutorial Truncate long filename. Temporary fix 2016-09-23 20:38:56 +01:00
.gitignore rake to render all docs to www/ correctly with links 2016-09-26 06:21:05 +02:00
config.rb switch to redcarpet for rendering 2016-09-26 06:21:05 +02:00
config.ru Fixup rubocop violation in www/ 2016-09-13 15:11:48 +01:00
Gemfile switch to redcarpet for rendering 2016-09-26 06:21:05 +02:00
Gemfile.lock switch to redcarpet for rendering 2016-09-26 06:21:05 +02:00
README.md add build tasks for www/tutorial 2016-09-23 15:27:34 +02:00

README.md

InSpec homepage

Development

Get all dependencies:

bundle install

To run it live run:

bundle exec middleman server

For the online tutorial, take a look at www/tutorial.

Building

To build the site to a local static folder (without tutorial):

bundle exec middleman build

To build everything including the online tutorial:

bundle exec rake www:build

Releasing

To push a new version of the website, make sure that you have built the site (see previous section) and that you are happy with the results. If so, run:

bundle exec rake www:release

It will clear and create a local gh-pages branch, add the site to it, and ask you before it pushes everything to origin/gh-pages i.e. the live website.