aboutsummaryrefslogtreecommitdiff
path: root/development/libs/barrel/docs/blue-penguin/README.md
diff options
context:
space:
mode:
authorMx Kookie <kookie@spacekookie.de>2020-10-31 20:17:22 +0100
committerMx Kookie <kookie@spacekookie.de>2020-12-21 05:19:21 +0100
commita9f4dd41c11bc4255823ebad7ceabf033cf32ecf (patch)
treed91064e96e60f444076c9ffc122a47afe3b22a72 /development/libs/barrel/docs/blue-penguin/README.md
parent534807c7a3a3b96d219ec0ce9bb0b3029aa1bdd9 (diff)
Add 'development/libs/barrel/' from commit 'f3b8ab47d3a3ad8d43dc2b89a5eec1c4e87b033d'
git-subtree-dir: development/libs/barrel git-subtree-mainline: 518551bfa6ef7d6508b425afa4bfb3ddbd418141 git-subtree-split: f3b8ab47d3a3ad8d43dc2b89a5eec1c4e87b033d
Diffstat (limited to 'development/libs/barrel/docs/blue-penguin/README.md')
-rw-r--r--development/libs/barrel/docs/blue-penguin/README.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/development/libs/barrel/docs/blue-penguin/README.md b/development/libs/barrel/docs/blue-penguin/README.md
new file mode 100644
index 000000000000..831bfc3364d2
--- /dev/null
+++ b/development/libs/barrel/docs/blue-penguin/README.md
@@ -0,0 +1,53 @@
+![screenshot](screenshot.png)
+
+# Blue Penguin for pelican
+A simple theme for pelican. Solarized pygments. Feeds support.
+
+## Settings
+```python
+# all the following settings are *optional*
+
+# HTML metadata
+SITEDESCRIPTION = ''
+
+# all defaults to True.
+DISPLAY_HEADER = True
+DISPLAY_FOOTER = True
+DISPLAY_HOME = True
+DISPLAY_MENU = True
+
+# provided as examples, they make ‘clean’ urls. used by MENU_INTERNAL_PAGES.
+TAGS_URL = 'tags'
+TAGS_SAVE_AS = 'tags/index.html'
+AUTHORS_URL = 'authors'
+AUTHORS_SAVE_AS = 'authors/index.html'
+CATEGORIES_URL = 'categories'
+CATEGORIES_SAVE_AS = 'categories/index.html'
+ARCHIVES_URL = 'archives'
+ARCHIVES_SAVE_AS = 'archives/index.html'
+
+# use those if you want pelican standard pages to appear in your menu
+MENU_INTERNAL_PAGES = (
+ ('Tags', TAGS_URL, TAGS_SAVE_AS),
+ ('Authors', AUTHORS_URL, AUTHORS_SAVE_AS),
+ ('Categories', CATEGORIES_URL, CATEGORIES_SAVE_AS),
+ ('Archives', ARCHIVES_URL, ARCHIVES_SAVE_AS),
+)
+# additional menu items
+MENUITEMS = (
+ ('GitHub', 'https://github.com/'),
+ ('Linux Kernel', 'https://www.kernel.org/'),
+)
+```
+
+## How to contribute
+Contributions are very welcome. Keep in mind that this theme goal is to be
+minimalistic/simple. Contributions will be accepted through Github Pull
+Requests. If you don’t have a Github account you can suggest me your
+changes by email (which you can find on my github profile).
+
+## Contributors
+See [CONTRIBUTORS.md](CONTRIBUTORS.md).
+
+## License
+Public domain.