Code formatting

main
Raymond Wanyoike 2017-11-22 00:28:08 +03:00
parent f23520fb29
commit df7bd65160
1 changed files with 41 additions and 21 deletions

View File

@ -4,42 +4,54 @@ Unless otherwise specified, settings that refer to paths can be either absolute
Subtitle that appears in the header:
SITESUBTITLE = 'A magical \u2728 Pelican theme'
```python
SITESUBTITLE = 'A magical \u2728 Pelican theme'
```
## SITEIMAGE
Image that appears in the header:
SITEIMAGE = '/images/profile.png'
```python
SITEIMAGE = '/images/profile.png'
```
You can also force the image size:
SITEIMAGE = '/images/profile.svg width=200 height=200'
```python
SITEIMAGE = '/images/profile.svg width=200 height=200'
```
## DESCRIPTION
Index HTML head `<meta>` description:
DESCRIPTION = 'A functional, clean, responsive theme for Pelican. Heavily ' \
'inspired by crowsfoot and clean-blog, powered by Bootstrap.'
```python
DESCRIPTION = 'A functional, clean, responsive theme for Pelican. Heavily ' \
'inspired by crowsfoot and clean-blog, powered by Bootstrap.'
```
## LINKS
A list of tuples (Title, URL) for menu links:
LINKS = (
('Pelican', 'http://getpelican.com/'),
('Python.org', 'http://python.org/'),
('Jinja2', 'http://jinja.pocoo.org/'),
)
```python
LINKS = (
('Pelican', 'http://getpelican.com/'),
('Python.org', 'http://python.org/'),
('Jinja2', 'http://jinja.pocoo.org/'),
)
```
## ICONS
A list of tuples (Icon, URL) for icon links:
ICONS = (
('github', 'https://github.com/nairobilug/pelican-alchemy'),
)
```python
ICONS = (
('github', 'https://github.com/nairobilug/pelican-alchemy'),
)
```
Icon in (Icon, URL) is a Font Awesome [icon](http://fontawesome.io/icons/) without the `fa-` prefix.
@ -49,7 +61,9 @@ You can choose one of the built-in Pygments styles for syntax highlighting.
By default the `default` style is used:
PYGMENTS_STYLE = 'default'
```python
PYGMENTS_STYLE = 'default'
```
The following styles are available:
@ -86,18 +100,24 @@ For a demo of the different styles, see [link](http://pygments.org/demo/).
Hide the author(s) of an article - useful for single author sites:
HIDE_AUTHORS = True
```python
HIDE_AUTHORS = True
```
## NEW_FAVICONS
Use a [realfavicongenerator](https://realfavicongenerator.net/blog/new-favicon-package-less-is-more/) favicon package:
RFG_FAVICONS = True
```python
RFG_FAVICONS = True
```
---
DISQUS_SITENAME = '...'
GAUGES = '...'
GOOGLE_ANALYTICS = '...'
PIWIK_URL = '...'
PIWIK_SITE_ID = '...'
```python
DISQUS_SITENAME = '...'
GAUGES = '...'
GOOGLE_ANALYTICS = '...'
PIWIK_URL = '...'
PIWIK_SITE_ID = '...'
```