archive
/
pelican-mg
mirror of https://github.com/c0de-archive/pelican-mg.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README

This commit is contained in:
Luca Chiricozzi 2015-11-23 19:18:35 +01:00
parent d365aaafb7
commit 9e3e83d758
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -49,6 +49,8 @@ Settings
The following settings are required for a correct behaviour of this theme.
If you want to use the theme with search enabled (and probably you want it).
```python
TAG_SAVE_AS = ''
AUTHOR_SAVE_AS = ''
@ -56,6 +58,14 @@ The following settings are required for a correct behaviour of this theme.
TIPUE_SEARCH_SAVE_AS = 'tipue_search.json'
```
If you want to use mg with search disabled.
```python
TAG_SAVE_AS = ''
AUTHOR_SAVE_AS = ''
DIRECT_TEMPLATES = ('index', 'categories', 'archives')
```
###Optional settings
**ALT_NAME**
@ -64,6 +74,9 @@ An alternative name for your site. It appears in the header bar.
**DESCRIPTION**
A brief description of your site, for social networks and search engines.
**DISABLE_SEARCH**
Disable search, boolean.
**FAVICON**
The relative path of your favicon, this is needed for Disqus forum favicon.