mirror of https://github.com/capistrano/capistrano synced 2023-03-27 23:21:18 -04:00

History

Matt Brictson f513c2d6b4 Document new SCM plugin system		2016-08-30 18:09:07 -07:00
..
_includes	Document new SCM plugin system	2016-08-30 18:09:07 -07:00
_layouts	Move gh-pages site to the docs/ folder	2016-08-23 18:04:57 -07:00
_posts	Move gh-pages site to the docs/ folder	2016-08-23 18:04:57 -07:00
css	Move gh-pages site to the docs/ folder	2016-08-23 18:04:57 -07:00
documentation	Document new SCM plugin system	2016-08-30 18:09:07 -07:00
fonts	Move gh-pages site to the docs/ folder	2016-08-23 18:04:57 -07:00
images	Move gh-pages site to the docs/ folder	2016-08-23 18:04:57 -07:00
js	Move gh-pages site to the docs/ folder	2016-08-23 18:04:57 -07:00
_config.yml	Move gh-pages site to the docs/ folder	2016-08-23 18:04:57 -07:00
CNAME	Move gh-pages site to the docs/ folder	2016-08-23 18:04:57 -07:00
favicon.ico	Move gh-pages site to the docs/ folder	2016-08-23 18:04:57 -07:00
Gemfile	Fix RuboCop Style/StringLiterals violation	2016-08-26 17:33:15 -07:00
Gemfile.lock	Move gh-pages site to the docs/ folder	2016-08-23 18:04:57 -07:00
index.markdown	Remove remaining ref to old documentation repo	2016-08-30 18:02:20 -07:00
README.md	Reference the new documentation location (docs/)	2016-08-26 17:33:15 -07:00

README.md

capistranorb.com

This docs/ directory generates the capistranorb.com site. Feel free to send pull requests to make improvements to Capistrano's documentation!

Quick start

This is a GitHub Pages project, which means it is built using Jekyll. To run the site locally, you'll need a functioning Ruby environment.

After checking out the capistrano repository, run:

cd docs
bundle install

Then start the Jekyll server with:

bundle exec jekyll serve

You should now be able to preview the site on http://localhost:4000. After making any changes to markdown or HTML files, just refresh your browser to see the results. You do not have to restart the Jekyll process.

More information: Using Jekyll with Pages.