updated documentation

This commit is contained in:
Panos Sakkos 2015-11-24 01:58:26 +01:00
parent 5b2c86badc
commit 47f161a51c
4 changed files with 32 additions and 5 deletions

View file

@ -61,7 +61,7 @@ The theme contains documentation in the form of [blog posts](https://panossakkos
### Blog Archive
![Archive](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/archive.jpg)
### Gesture navigation instructions
![Instuctions](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/swipe.jpg)
![Instructions](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/swipe.jpg)
### Post page
![Post](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/post.jpg)
### \#Tags
@ -92,12 +92,23 @@ Then, you can build and serve your website by simply running:
## Wiki
Don't forget to list your { Personal } blog in the [Blogs using { Personal }](https://github.com/PanosSakkos/personal-jekyll-theme/wiki/Blogs-using-%7B-Personal-%7D) wiki page in order to drive some traffic to your website 😉
Don't forget to list your { Personal } blog in the [Blogs using { Personal }](https://github.com/PanosSakkos/personal-jekyll-theme/wiki/Blogs-using-%7B-Personal-%7D) wiki page in order to drive some traffic to your website :wink:
## Integrating bug fixes and features into your old fork
Have you published your own website by forking { Personal } and now you want to get the latest bug fixes and features from this repo into your website?
Then check [this](https://github.com/PanosSakkos/personal-jekyll-theme/wiki/How-to-integrate-latest-bug-fixes-and-features-into-your-past-fork) out.
Then check [this](https://github.com/PanosSakkos/personal-jekyll-theme/wiki/Integrating-latest-bug-fixes-and-features-into-your-past-fork) out.
## OSS used in { Personal }
One of the reasons { Personal } is real is the following OSS projects:
1. [Grayscale](http://startbootstrap.com/template-overviews/grayscale/)
2. [hammer.js](https://hammerjs.github.io/)
3. [highlightjs](https://highlightjs.org/)
4. [RRSSB](https://github.com/kni-labs/rrssb)
5. [Timeline](https://github.com/kirbyt/timeline-jekyll-theme)
6. [typed.js](https://github.com/mattboldt/typed.js/)
## Supporting the repo

View file

@ -38,11 +38,12 @@ Many share buttons are available and can be enabled or disabled by setting the f
email-share: True
fb-share: True
twitter-share: True
linkedin-share: True
reddit-share: True
google-plus-share: True
linkedin-share: True
tumblr-share: True
pinterest-share: True
pocket-share: True
vkontakte-share: True
</code></pre>

15
scripts/README.md Normal file
View file

@ -0,0 +1,15 @@
serve-production
- Builds and serves your website in 127.0.0.1:4000
serve
- Builds and serves your website without generating the Disqus comments and the Google Analytics code
new-post <title>
- Creates a new post under \_posts
generate-tag
- Generate all the tags that are used in the \_posts
integrate-personal
- Integrates the latest bug fixes and new features from personal-jekyll-theme repository.
Make sure to read [this](https://github.com/PanosSakkos/personal-jekyll-theme/wiki/Integrating-latest-bug-fixes-and-features-into-your-past-fork) before using it.

View file

@ -4,7 +4,7 @@
require 'fileutils'
personal = ARGV[0]
personal = "../personal-jekyll-theme"
repoDirectories = [ '_includes', '_layouts', '_sass', 'blog', 'css', 'js' ]
repoFiles = [ 'feed.xml', 'manifest.json', 'sitemap.xml' ]