dan/api_docs
1
0
Fork 0
mirror of https://github.com/danbulant/api_docs synced 2026-06-21 15:41:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source 
Fixed some more formatting problems, and reworded a few sections.
This commit is contained in:
Robert Lord 2013-10-07 14:47:09 -07:00
parent 916412b51b
commit e7a0552edc
1 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -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?