Commit e7a0552e authored by Robert Lord's avatar Robert Lord

Update README.md

Fixed some more formatting problems, and reworded a few sections.
parent 916412b5
...@@ -30,15 +30,15 @@ You can now see the docs at <http://localhost:4567>. Whoa! That was fast! ...@@ -30,15 +30,15 @@ You can now see the docs at <http://localhost:4567>. Whoa! That was fast!
Just edit the markdown file `source/index.md`! Super easy. If you know markdown, we think that the Kittn example in `source/index.md` is mostly self explanatory, but be sure to check out `syntax.md` if you need a better explanation. Just edit the markdown file `source/index.md`! Super easy. If you know markdown, we think that the Kittn example in `source/index.md` is mostly self explanatory, but be sure to check out `syntax.md` if you need a better explanation.
### Pushing Your Changes ### Publishing Your Docs
Publishing your changes couldn't be more simple. Publishing your API documentation couldn't be more simple.
1. Commit your changes to the markdown source: `git commit -a` 1. Commit your changes to the markdown source: `git commit -a`
2. Push source changes to Github: `git push` (Note that at this point, we've only updated the ''markdown source'' on Github. We still haven't published the generated HTML to the `gh-pages` branch.) 2. Push source changes to Github: `git push` (Note that at this point, we've only updated the ''markdown source'' on Github. We still haven't published the generated HTML to the `gh-pages` branch.)
3. Build the site, commit, and push the `gh-pages` branch: `rake publish` 3. Build the site, commit, and push the `gh-pages` branch: `rake publish`
Done! Your changes should now be live on [http://yourusername.github.io/slate], and the main branch should be updated with your edited markdown. Done! Your changes should now be live on <http://yourusername.github.io/slate>, and the main branch should be updated with your edited markdown.
### Don't Want to Use Github Pages? ### Don't Want to Use Github Pages?
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment