github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve English documentation with enhanced clarity, grammar, and spelling

Browse source
This commit is contained in:
Justin Mayer 2012-03-06 06:13:17 -08:00
commit bde06c4011
11 changed files with 429 additions and 403 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/tips.rst
View file

@ -1,22 +1,22 @@
Tips
####
Here are some tips about pelican, which you might find useful.
Here are some tips about Pelican that you might find useful.
Publishing to github
Publishing to GitHub
====================
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
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.
The excellent `ghp-import <https://github.com/davisp/ghp-import>`_ makes this
eally easy. You would have to install it::
really easy. You will have to install it::
$ pip install ghp-import
Then, considering a repository containing your articles, you would simply have
to run pelican and upload the output to github::
Then, given a repository containing your articles, you would simply have
to run Pelican and upload the output to GitHub::
$ pelican -s pelican.conf.py .
$ ghp-import output
@ -24,8 +24,8 @@ to run pelican and upload the output to github::
And that's it.
If you want you can put that directly into a post commit hook, so each time you
commit, your blog is up to date on github!
If you want, you can put that directly into a post-commit hook, so each time you
commit, your blog is up to date on GitHub!
Put the following into `.git/hooks/post-commit`::