diff --git a/docs/tips.rst b/docs/tips.rst index 6ddc3d33..14a79a5e 100644 --- a/docs/tips.rst +++ b/docs/tips.rst @@ -10,6 +10,26 @@ GitHub comes with an interesting "pages" feature: you can upload things there and it will be available directly from their servers. As Pelican is a static file generator, we can take advantage of this. +User Pages +---------- +Github allows you to create user pages in the form of ``username.github.com``. +Whatever is created in master branch will be published. For this purposes just +the output generated by pelican needs to pushed at github. + +So given a repository containing your articles, just run pelican over the posts +and deploy the master branch at github:: + + $ pelican -s pelican.conf.py ./path/to/posts -o /path/to/output + +Now add all the files in the output directory generated by pelican:: + + $ git add /path/to/output/* + $ git commit -am "Your Message" + $ git push origin master + +Project Pages +------------- +For creating Project pages, a branch called ``gh-pages`` is used for publishing. The excellent `ghp-import `_ makes this really easy. You will have to install it:: @@ -31,3 +51,4 @@ Put the following into `.git/hooks/post-commit`:: pelican -s pelican.conf.py . && ghp-import output && git push origin gh-pages +