ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / tips / github.mdwn
1 Here's how to set up a static wiki or blog using ikiwiki with no hosting
2 fees. Everything is hosted on github, both the git repository and the web
3 site. Your laptop is used to generate and publish changes to it.
4
5 This is possible because github now supports
6 [github pages](http://github.com/blog/272-github-pages).
7
8 Note that github limits free accounts to 100 MB of git storage. It's
9 unlikely that a small wiki or blog will outgrow this, but we are keeping
10 two copies of the website in git (source and the compiled site), and all
11 historical versions too. So it could happen. If it does, you can pay github
12 for more space, or you can migrate your site elsewhere.
13
14 ## Github Setup
15
16 * Go to [github](http://github.com/) and sign up for an account, if you haven't already. 
17 * Be sure to add your laptop's ssh key to it so you can push to github.
18 * Create a repository on github named `$YOU.github.com`, substituting your
19   *username*. This repository will be used to publish your compiled website.
20 * Create a repository on github named `$YOU` (or anything else you like).
21   This repository will be used to publish the source of your website.
22   This is actually optional.
23
24 ## Local Setup
25
26 * On your laptop, create two empty git repositories to correspond to the github repositories: <br />
27         `YOU=your github username here` <br />
28         `mkdir ~/$YOU.github.com` <br />
29         `cd ~/$YOU.github.com` <br />
30         `git init` <br />
31         `git remote add origin git@github.com:$YOU/$YOU.github.com.git` <br />
32         `mkdir ~/$YOU` <br />
33         `cd ~/$YOU` <br />
34         `git init` <br />
35         `git remote add origin git@github.com:$YOU/$YOU.git` <br />
36 * Add some wiki pages, such as an `index.mdwn`, to `~/$YOU`, and check them
37   in and commit them to git. You need something to push to github. Run
38   `git push origin master` to push the source pages to github.
39
40 ## Publishing to Github
41
42 * Now build your wiki with a command such as: <br />
43         `ikiwiki ~/$YOU ~/$YOU.github.com --refresh`
44 * Each time you build the wiki you will need to commit the changes
45   to git, and push the compiled pages to github: <br />
46         `cd ~/YOU.github.com` <br />
47         `git add .` <br />
48         `git commit -a -m update` <br />
49         `git push origin master` <br />
50
51 Your wiki will show up at `http://$YOU.github.com/` within ten
52 minutes after the first push, and changes you push to it from then on
53 should show up immediately.
54
55 ## Enhancements
56
57 You can follow the instructions in [[laptop_wiki_with_git]] to set up an
58 editable version of your wiki on your laptop. Then you can use the web
59 interface for editing. You'll still need to follow the instructions above
60 to publish your changes to github.
61
62 It would also be possible to teach ikiwiki to push compiled pages to github
63 itself via a plugin, as was done with the [[plugins/amazon_s3]] plugin. Not
64 done yet!