archive/pelican-mg
1
0
Fork 0
mirror of https://github.com/c0de-archive/pelican-mg.git synced 2024-11-01 07:17:47 +00:00
Code Issues Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Luca Chiricozzi 2014-12-30 20:28:43 +01:00
parent f3cda23546
commit e76c42625c
1 changed files with 5 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -17,7 +17,6 @@ Features
-------------- --------------
* [Open Graph](http://ogp.me/) supports for pages and articles. * [Open Graph](http://ogp.me/) supports for pages and articles.
* Show a custom image instead of your site name.
* Comment with DISQUS. * Comment with DISQUS.
* Google Analytics. * Google Analytics.
* Responsive design. * Responsive design.
@ -42,15 +41,10 @@ A brief description of your site, for Open Graph and search engines.
**FOOTER** **FOOTER**
A custom footer notice. A custom footer notice.
**LOGO**
The path of a custom image for replacing the site name in your header bar.
The path is relative to the "/static/" folder of your site, so if your image
is placed at "www.example.com/static/img/logo.png", the path to insert is
"img/logo.png".
**OG_IMAGE** **OG_IMAGE**
The path of a custom image for the `og:image` meta property. As for **LOGO**, The path of a custom image for the `og:image` meta property.
the path is relative to the "/static/" folder of your site. The path is relative to the "/static/" folder of your site, so if your image
is placed at "www.example.com/static/img/pic.png", the path to insert is "img/pic.png"
**OG_IMAGE_TYPE** **OG_IMAGE_TYPE**
The MIME type for **OG_IMAGE**. The MIME type for **OG_IMAGE**.
@ -66,8 +60,8 @@ Enable share buttons, boolean.
**SOCIAL** **SOCIAL**
A list of tutples (icon, URL). The icons are from [Font Awesome] A list of tutples (icon, URL). The icons are from [Font Awesome]
(http://fortawesome.github.io/Font-Awesome/). The suffix "-square" is stripped (http://fortawesome.github.io/Font-Awesome/). The suffix "-square" is removed
away in the bottom icons of the small screen layout. in the footer icons of the small screen layout.
e.g. e.g.
```python ```python
SOCIAL = (('twitter', 'https://twitter.com/luca_chr'), SOCIAL = (('twitter', 'https://twitter.com/luca_chr'),