voila

[git.ikiwiki.info.git] / doc / tips / github.mdwn

diff --git a/doc/tips/github.mdwn b/doc/tips/github.mdwn
index cd1b479d1e6b8d425bb4fe5cd0a207ba4ae39727..c3fdab7345b22958283179a1b19306e508dd25c8 100644 (file)
--- a/doc/tips/github.mdwn
+++ b/doc/tips/github.mdwn
@@ -1,5 +1,5 @@
 Here's how to set up a static wiki or blog using ikiwiki with no hosting
 Here's how to set up a static wiki or blog using ikiwiki with no hosting

-feeds. Everything is hosted on github, both the git repository and the web
+fees. Everything is hosted on github, both the git repository and the web

 site. Your laptop is used to generate and publish changes to it.
 
 This is possible because github now supports
 site. Your laptop is used to generate and publish changes to it.
 
 This is possible because github now supports


@@ -11,51 +11,48 @@ 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.
 
 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.
 
 * 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:
-       YOU=# your github username here
-       mkdir ~/$YOU.github.com
-       cd ~/$YOU.github.com
-       git init
-       git remote add origin git@github.com:$YOU/$YOU.github.com.git
-       mkdir ~/$YOU
-       cd ~/$YOU
-       git init
-       git remote add origin git@github.com:$YOU/$YOU.git
+* 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 />
+       `git remote add origin git@github.com:$YOU/$YOU.github.com.git` <br />
+       `mkdir ~/$YOU` <br />
+       `cd ~/$YOU` <br />
+       `git init` <br />
+       `git remote add origin git@github.com:$YOU/$YOU.git` <br />

 * Add some wiki pages, such as an `index.mdwn`, to `~/$YOU`, and check them
   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.
 
 * Add some wiki pages, such as an `index.mdwn`, to `~/$YOU`, and check them
   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
 * 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
 
 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
 
 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