#The Ghost Guide

We've put together a short guide to help you get started with Ghost. This guide will take you through installing Ghost for the first time, getting everything set up, customising your blog, as well as getting started with basic theme and plugin development. The Ghost Guide is available to read online by anyone at docs.ghost.org.

Running Locally

If you would like to download these docs and run them locally/offline for your own use and modification, pleae follow these instructions to get started:

1. Clone the Ghost repository and check out the /gh-pages/ branch
2. Go to this directory - cd ~/User/path/to/Ghost
3. Edit _config.yml and comment out the url: line
4. Install Jekyll - $ gem install jekyll
5. Build the docs - $ jekyll build
6. Start the server - $ jekyll serve
7. View the docs on http://localhost:4478

Contributions

Pleas submit Pull Requests if you would like to contribute to this documentation for Ghost - referencing any relevant or open issues in the bug tracker.

All code should conform, strictly, to the Ghost project Code Standards.

All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.

Copyright & License

Copyright (C) 2013 The Ghost Foundation - Released under the MIT Lincense.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.