]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/tips/github.mdwn
new version of the ikiwiki vim plugin. docs upgraded. new forum post
[ikiwiki.git] / doc / tips / github.mdwn
index 0a76166ee5213ecf3b4a8656c5b52aada3308ff9..9bdf157519590ee7213901088f1aadd5ae98aa0c 100644 (file)
@@ -11,23 +11,20 @@ two copies of the website in git (source and the compiled site), and all
 historical versions too. So it could happen. If it does, you can pay github
 for more space, or you can migrate your site elsewhere.
 
-## github setup
+## Github Setup
 
-* Go to [github](http://github.com/) and sign up for an account, if you
-  haven't already. 
-* Be sure to add your laptop's ssh key to it so you can push
-  to github.
-* Create a repository on githib named `$YOU.github.com`, substituting your
-  username. This repository will be used to publish your compiled website.
+* Go to [github](http://github.com/) and sign up for an account, if you haven't already. 
+* Be sure to add your laptop's ssh key to it so you can push to github.
+* Create a repository on github named `$YOU.github.com`, substituting your
+  *username*. This repository will be used to publish your compiled website.
 * Create a repository on github named `$YOU` (or anything else you like).
   This repository will be used to publish the source of your website.
   This is actually optional.
 
-## local setup
+## Local Setup
 
-* On your laptop, create two empty git repositories to correspond to the
-  github repositories: <br />
-       `YOU = your github username here` <br />
+* On your laptop, create two empty git repositories to correspond to the github repositories: <br />
+       `YOU=your github username here` <br />
        `mkdir ~/$YOU.github.com` <br />
        `cd ~/$YOU.github.com` <br />
        `git init` <br />
@@ -40,22 +37,22 @@ for more space, or you can migrate your site elsewhere.
   in and commit them to git. You need something to push to github. Run
   `git push origin master` to push the source pages to github.
 
-## publishing to github
+## Publishing to Github
 
-* Now build your wiki with a command such as:
-       ikiwiki ~/$YOU ~/$YOU.github.com --refresh
+* Now build your wiki with a command such as: <br />
+       `ikiwiki ~/$YOU ~/$YOU.github.com --refresh`
 * Each time you build the wiki you will need to commit the changes
-  to git, and push the compiled pages to github:
-       cd ~/YOU.github.com
-       git add .
-       git commit -a -m update
-       git push origin master
+  to git, and push the compiled pages to github: <br />
+       `cd ~/YOU.github.com` <br />
+       `git add .` <br />
+       `git commit -a -m update` <br />
+       `git push origin master` <br />
 
 Your wiki will show up at `http://$YOU.github.com/` within ten
 minutes after the first push, and changes you push to it from then on
-should show up immediatly.
+should show up immediately.
 
-## enhancements
+## Enhancements
 
 You can follow the instructions in [[laptop_wiki_with_git]] to set up an
 editable version of your wiki on your laptop. Then you can use the web