blog-theme/docs/settings.md

126 lines
2.0 KiB
Markdown
Raw Normal View History

# Settings
2017-03-07 10:01:23 +01:00
Unless otherwise specified, settings that refer to paths can be either absolute or relative to the configuration file.
## SITESUBTITLE
Subtitle that appears in the header:
2017-11-21 22:28:08 +01:00
```python
SITESUBTITLE = 'A magical \u2728 Pelican theme'
```
2017-03-07 10:01:23 +01:00
## SITEIMAGE
Image that appears in the header:
2017-11-21 22:28:08 +01:00
```python
SITEIMAGE = '/images/profile.png'
```
2017-03-07 10:01:23 +01:00
You can also force the image size:
2017-11-21 22:28:08 +01:00
```python
SITEIMAGE = '/images/profile.svg width=200 height=200'
```
2017-03-07 10:01:23 +01:00
## DESCRIPTION
Index HTML head `<meta>` description:
2017-11-21 22:28:08 +01:00
```python
DESCRIPTION = 'A functional, clean, responsive theme for Pelican. Heavily ' \
'inspired by crowsfoot and clean-blog, powered by Bootstrap.'
```
2017-03-07 10:01:23 +01:00
## LINKS
A list of tuples (Title, URL) for menu links:
2017-11-21 22:28:08 +01:00
```python
LINKS = (
('Pelican', 'http://getpelican.com/'),
('Python.org', 'http://python.org/'),
('Jinja2', 'http://jinja.pocoo.org/'),
)
```
2017-03-07 10:01:23 +01:00
## ICONS
A list of tuples (Icon, URL) for icon links:
2017-11-21 22:28:08 +01:00
```python
ICONS = (
('github', 'https://github.com/nairobilug/pelican-alchemy'),
)
```
2017-03-07 10:01:23 +01:00
Icon in (Icon, URL) is a Font Awesome [icon](http://fontawesome.io/icons/) without the `fa-` prefix.
## PYGMENTS_STYLE
You can choose one of the built-in Pygments styles for syntax highlighting.
By default the `default` style is used:
2017-11-21 22:28:08 +01:00
```python
PYGMENTS_STYLE = 'default'
```
2017-03-07 10:01:23 +01:00
The following styles are available:
- algol
- algol_nu
- autumn
- borland
- bw
- colorful
- default
- emacs
- friendly
- fruity
- igor
- lovelace
- manni
- monokai
- murphy
- native
- paraiso-dark
- paraiso-light
- pastie
- perldoc
- rrt
- tango
- trac
- vim
- vs
- xcode
For a demo of the different styles, see [link](http://pygments.org/demo/).
## HIDE_AUTHORS
Hide the author(s) of an article - useful for single author sites:
2017-11-21 22:28:08 +01:00
```python
HIDE_AUTHORS = True
```
2017-03-07 10:01:23 +01:00
## NEW_FAVICONS
Use a [realfavicongenerator](https://realfavicongenerator.net/blog/new-favicon-package-less-is-more/) favicon package:
2017-11-21 22:28:08 +01:00
```python
RFG_FAVICONS = True
```
2017-03-07 10:01:23 +01:00
---
2017-11-21 22:28:08 +01:00
```python
DISQUS_SITENAME = '...'
GAUGES = '...'
GOOGLE_ANALYTICS = '...'
PIWIK_URL = '...'
PIWIK_SITE_ID = '...'
```