mirror of
https://github.com/c0de-archive/pelican-mg.git
synced 2024-11-01 07:17:47 +00:00
Updated README
This commit is contained in:
parent
f3cda23546
commit
e76c42625c
16
README.md
16
README.md
@ -17,7 +17,6 @@ Features
|
||||
--------------
|
||||
|
||||
* [Open Graph](http://ogp.me/) supports for pages and articles.
|
||||
* Show a custom image instead of your site name.
|
||||
* Comment with DISQUS.
|
||||
* Google Analytics.
|
||||
* Responsive design.
|
||||
@ -42,15 +41,10 @@ A brief description of your site, for Open Graph and search engines.
|
||||
**FOOTER**
|
||||
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**
|
||||
The path of a custom image for the `og:image` meta property. As for **LOGO**,
|
||||
the path is relative to the "/static/" folder of your site.
|
||||
The path of a custom image for the `og:image` meta property.
|
||||
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**
|
||||
The MIME type for **OG_IMAGE**.
|
||||
@ -66,8 +60,8 @@ Enable share buttons, boolean.
|
||||
|
||||
**SOCIAL**
|
||||
A list of tutples (icon, URL). The icons are from [Font Awesome]
|
||||
(http://fortawesome.github.io/Font-Awesome/). The suffix "-square" is stripped
|
||||
away in the bottom icons of the small screen layout.
|
||||
(http://fortawesome.github.io/Font-Awesome/). The suffix "-square" is removed
|
||||
in the footer icons of the small screen layout.
|
||||
e.g.
|
||||
```python
|
||||
SOCIAL = (('twitter', 'https://twitter.com/luca_chr'),
|
||||
|
Loading…
Reference in New Issue
Block a user