1
0
Fork 0
mirror of https://github.com/capistrano/capistrano synced 2023-03-27 23:21:18 -04:00
capistrano/docs/README.md

25 lines
825 B
Markdown
Raw Normal View History

# capistranorb.com
2014-01-14 05:48:01 -05:00
This `docs/` directory generates the [capistranorb.com](http://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](https://help.github.com/articles/using-jekyll-with-pages/).