Permalink
Browse files

Updated pelican-bootstrap3 to the latest version

  • Loading branch information...
DandyDev committed Aug 21, 2014
1 parent a928687 commit 352965e0445417584f6c3fb3e8fef5d87db4f37f
Showing with 1,589 additions and 567 deletions.
  1. +48 −0 pelican-bootstrap3/EXAMPLES.md
  2. +17 −9 pelican-bootstrap3/LICENSE
  3. +70 −10 pelican-bootstrap3/README.md
  4. +7 −1 pelican-bootstrap3/static/css/bootstrap.amelia.min.css
  5. +7 −1 pelican-bootstrap3/static/css/bootstrap.cerulean.min.css
  6. +7 −1 pelican-bootstrap3/static/css/bootstrap.cosmo.min.css
  7. +7 −0 pelican-bootstrap3/static/css/bootstrap.cupid.min.css
  8. +7 −1 pelican-bootstrap3/static/css/bootstrap.cyborg.min.css
  9. +7 −0 pelican-bootstrap3/static/css/bootstrap.darkly.min.css
  10. +7 −1 pelican-bootstrap3/static/css/bootstrap.flatly.min.css
  11. +7 −1 pelican-bootstrap3/static/css/bootstrap.journal.min.css
  12. +7 −0 pelican-bootstrap3/static/css/bootstrap.lumen.min.css
  13. +4 −4 pelican-bootstrap3/static/css/bootstrap.min.css
  14. +7 −1 pelican-bootstrap3/static/css/bootstrap.readable.min.css
  15. +7 −0 pelican-bootstrap3/static/css/bootstrap.shamrock.min.css
  16. +7 −1 pelican-bootstrap3/static/css/bootstrap.simplex.min.css
  17. +7 −1 pelican-bootstrap3/static/css/bootstrap.slate.min.css
  18. +7 −1 pelican-bootstrap3/static/css/bootstrap.spacelab.min.css
  19. +7 −0 pelican-bootstrap3/static/css/bootstrap.superhero.min.css
  20. +7 −1 pelican-bootstrap3/static/css/bootstrap.united.min.css
  21. +7 −1 pelican-bootstrap3/static/css/bootstrap.yeti.min.css
  22. +251 −23 pelican-bootstrap3/static/css/font-awesome.css
  23. +2 −2 pelican-bootstrap3/static/css/font-awesome.min.css
  24. +70 −0 pelican-bootstrap3/static/css/pygments/zenburn.css
  25. +9 −2 pelican-bootstrap3/static/css/style.css
  26. BIN pelican-bootstrap3/static/fonts/FontAwesome.otf
  27. BIN pelican-bootstrap3/static/fonts/fontawesome-webfont.eot
  28. +469 −379 pelican-bootstrap3/static/fonts/fontawesome-webfont.svg
  29. BIN pelican-bootstrap3/static/fonts/fontawesome-webfont.ttf
  30. BIN pelican-bootstrap3/static/fonts/fontawesome-webfont.woff
  31. +4 −5 pelican-bootstrap3/static/js/bootstrap.min.js
  32. +4 −0 pelican-bootstrap3/static/js/jquery.min.js
  33. +6 −5 pelican-bootstrap3/templates/archives.html
  34. +47 −0 pelican-bootstrap3/templates/article.html
  35. +22 −0 pelican-bootstrap3/templates/article_list.html
  36. +12 −8 pelican-bootstrap3/templates/author.html
  37. +18 −8 pelican-bootstrap3/templates/authors.html
  38. +42 −24 pelican-bootstrap3/templates/base.html
  39. +5 −1 pelican-bootstrap3/templates/category.html
  40. +9 −0 pelican-bootstrap3/templates/includes/aboutme.html
  41. +12 −4 pelican-bootstrap3/templates/includes/addthis.html
  42. +10 −8 pelican-bootstrap3/templates/includes/article_info.html
  43. +1 −1 pelican-bootstrap3/templates/includes/cc-license.html
  44. +1 −1 pelican-bootstrap3/templates/includes/comment_count.html
  45. +14 −4 pelican-bootstrap3/templates/includes/comments.html
  46. +2 −0 pelican-bootstrap3/templates/includes/disqus_script.html
  47. +14 −0 pelican-bootstrap3/templates/includes/ga.html
  48. +2 −0 pelican-bootstrap3/templates/includes/github-js.html
  49. +157 −0 pelican-bootstrap3/templates/includes/liquid_tags_nb_header.html
  50. +35 −19 pelican-bootstrap3/templates/includes/pagination.html
  51. +14 −14 pelican-bootstrap3/templates/includes/piwik.html
  52. +16 −6 pelican-bootstrap3/templates/includes/sidebar.html
  53. +27 −0 pelican-bootstrap3/templates/includes/twitter_cards.html
  54. +10 −0 pelican-bootstrap3/templates/includes/twitter_timeline.html
  55. +3 −16 pelican-bootstrap3/templates/index.html
  56. +37 −0 pelican-bootstrap3/templates/page.html
  57. +6 −2 pelican-bootstrap3/templates/tag.html
@@ -0,0 +1,48 @@
# Examples in the wild
This is a non-exhaustive list of websites that use **pelican-boostrap3** as their theme. It shows the versatility of
the theme (which is one of the perks of using Bootstrap 3). If your website provides a unique take on
**pelican-bootstrap3** and you want your website to be listed here, don't hesitate to ask or make a pull-request!
I reserve the right to refuse websites if they're not unique enough for my tastes or if I find them offensive.
If your website is listed here, but you don't want it to be, let me know and I'll remove it.
[DandyDev.net](http://dandydev.net) by [DandyDev](https://github.com/DandyDev) (Main author of pelican-bootstrap3) - Basic pelican-bootstrap3 setup using the _Simplex_ Bootswatch theme.
[Winlus blog](http://www.heroicdebugging.biz/) by [ingwinlu](https://github.com/ingwinlu) - Customized pelican-bootstrap3 based design using panels. Shows off the `USE_PAGER` setting.
[Mind Bending](http://mindbending.org/en) by [magnunleno](https://github.com/magnunleno) - Heavily customized design based on pelican-bootstrap3 with lots of stuff added. Some of that stuff was neatly contributed back to pelican-boostrap3.
[toumorokoshi](http://toumorokoshi.github.io/) by [toumorokoshi](https://github.com/toumorokoshi) - Clean version of pelican-bootstrap3 with a nice profile area added in.
[Christine Doig](http://chdoig.github.io/) by [chdoig](https://github.com/chdoig) - Barely recognizable anymore as pelican-boostrap3, but it is in fact [based on this theme](http://chdoig.github.io/create-pelican-blog.html). The Twitter widget has been contributed back to pelican-bootstrap3
[Rebecca Weiss](http://www.rebeccaweiss.info/) by [rjweiss](https://github.com/rjweiss)
[Theory And Practice](http://theoryandpractice.org/) by [cranmer](https://github.com/cranmer) - Nice customization of the frontpage, using widgets.
[The official ncf website](http://www.ncf.io/) by [Normation](https://github.com/Normation)
[Lappland. Inside Out.](http://lappland.io/) by [hlapp](https://github.com/hlapp)
[Kev009.com](http://kev009.com/wp/) by [kev009](https://github.com/kev009)
[dave_tucker:blog](http://dtucker.co.uk/) by [dave-tucker](https://github.com/dave-tucker)
[Dopey's Corner](http://dopey.io/)
[Toni Mueller](http://www.tonimueller.org/) by [muellert](https://github.com/muellert)
[Caffeinated Engineering](http://caffeinatedengineering.com/) by [mattyjones](https://github.com/mattyjones)
[Duncan Murdock](http://www.duncanmurdock.name/) by [damurdock](https://github.com/damurdock)
[Ryan Gregory James](http://csc.ucdavis.edu/~rgjames/) by [Autoplectic](https://github.com/Autoplectic)
[JPoser/Blog](http://jposer.net/) by [JPoser](https://github.com/JPoser)
[Base-Art](http://base-art.net/) by [philn](https://github.com/philn)
[Jason Antman's Blog](http://blog.jasonantman.com/) by [jantman](https://github.com/jantman)
[Bryce Boe](http://bryceboe.com/) by [bboe](https://github.com/bboe)
View
@@ -1,13 +1,21 @@
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004
The MIT License (MIT)
Copyright (C) 2013 Daan Debie <debie.daan@gmail.com>
Copyright (c) 2014 Daan Debie
Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
0. You just DO WHAT THE FUCK YOU WANT TO.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -32,14 +32,25 @@ This theme honors the following standard Pelican settings:
* `MENUITEMS`
* `LINKS` (Blogroll will be put in the sidebar instead of the head)
* Analytics & Comments
* `GOOGLE_ANALYTICS`
* `GOOGLE_ANALYTICS` (classic tracking code)
* `GOOGLE_ANALYTICS_UNIVERSAL` and `GOOGLE_ANALYTICS_UNIVERSAL_PROPERTY` (Universal tracking code)
* `DISQUS_SITENAME`
* `PIWIK_URL`, `PIWIK_SSL_URL` and `PIWIK_SITE_ID`
It uses the `tag_cloud` variable for displaying tags in the sidebar. You can control the amount of tags shown with: `TAG_CLOUD_MAX_ITEMS`
## Extras
### Bootswatch and other Bootstrap 3 themes
Part of the versatility of this theme comes from the fact that I included all the lovely Bootstrap 3 themes from [Bootswatch](http://bootswatch.com/), built by [Thomas Park](https://github.com/thomaspark). You can tell Pelican what Bootswatch theme to use, by setting `BOOTSTRAP_THEME` to the desired theme, in lowercase (ie. 'readable' or 'cosmo' etc.). My own site is using _Readable_. If you want to use any other Bootstrap 3 compatible theme, just put the minified CSS in the `static/css` directory and rename it using the following naming scheme: `bootstrap.{theme-name}.min.css`. Then update the `BOOTSTRAP_THEME` variable with the _theme-name_ used.
#### Update: Readable has seen some major changes. I added the new version as 'readable' and renamed the old version to 'readable-old'. Update your config accordingly.
### Article info
Set `SHOW_ARTICLE_AUTHOR` to True to show the author of the article at the top of the article and in the index of articles. Set `SHOW_ARTICLE_CATEGORY` to show the Category of each article.
### Custom CSS
If you want to add custom css to the theme, without having to clone and maintain your own version of the theme, you can use the `CUSTOM_CSS` variable. The value is the location where you tell Pelican to put the file (see below):
@@ -84,9 +95,14 @@ You can choose the syntax highlighting style by using the `PYGMENTS_STYLE` varia
- trac
- vim
- vs
- zenburn
For a demo of the different Pygment styles, have a look [here](http://pygments.org/demo/218030/)
### Pagination
Pelican-Bootstrap3 follows the standard Pagination settings of Pelican and uses the Bootstrap3 [Pagination component](http://getbootstrap.com/components/#pagination), but you can optionally use the Boostrap3 _Pager_ by setting `USE_PAGER` to `True`.
### Site Brand
You can provide a logo for your site using `SITELOGO`. For example: `SITELOGO = 'images/my_site_logo.png'`. You can then define the size of the logo using `SITELOGO_SIZE`. The `width` of the `<img>` element will be set accordingly.
@@ -105,10 +121,34 @@ If you wish to use the inverse navbar from Bootstrap, set the flag `BOOTSTRAP_NA
This theme has support for the [Related Posts plugin](https://github.com/getpelican/pelican-plugins/tree/master/related_posts). All you have to do, is enable the plugin, and the theme will do the rest.
### IPython Notebook support
This theme supports including IPython notebooks through the [Liquid Tags plugin](https://github.com/getpelican/pelican-plugins/tree/master/liquid_tags). If you enable the plugin, the theme will automatically include the right CSS/JS to make the notebooks work.
### Favicon
Set the `FAVICON` option in your `pelicanconf.py`. For example: `FAVICON = 'images/favicon.png'`
### Index page
* If `DISPLAY_ARTICLE_INFO_ON_INDEX` is set to _True_, article info (date, tags) will be show under the title for each article, otherwise only title and summary will be shown (default).
### Short menu labels for pages
By default, the title of a page is used both for showing the title as
part of a page's content, and, if pages in menu is enabled, as the
label of the corresponding menu item. You can choose a different label
for the menu (such as a short single word) than the page title by adding a
Menulabel metadata attribute to the page header (`Menulabel:` in
markdown, `:Menulabel:` in rst).
### About Me
You can show a short blurb of text about yourself and a picture. The following two settings are used for this:
* Your 'About Me' paragraph will be whatever the `ABOUT_ME` variable is set to (raw html is allowed)
* Your avatar can be set by pointing the `AVATAR` variable to the relevant picture (e.g. 'images/profile.png')
### Sidebar options
The following things can be displayed on the sidebar:
@@ -121,7 +161,8 @@ SOCIAL = (('twitter', 'http://twitter.com/DaanDebie'),
('linkedin', 'http://www.linkedin.com/in/danieldebie'),
('github', 'http://github.com/DandyDev'),)
```
* **Tags** will be shown if `DISPLAY_TAGS_ON_SIDEBAR` is set to _True_
* **Tags** will be shown if `DISPLAY_TAGS_ON_SIDEBAR` is set to _True_. Normally, tags are shown as a list.
* Set `DISPLAY_TAGS_INLINE` to _True_, to display the tags inline (ie. as tagcloud)
* **Categories** will be shown if `DISPLAY_CATEGORIES_ON_SIDEBAR` is set to _True_
* **Recent Posts** will be shown if `DISPLAY_RECENT_POSTS_ON_SIDEBAR` is set to _True_
* Use `RECENT_POST_COUNT` to control the amount of recent posts. Defaults to **5**
@@ -136,6 +177,7 @@ If you're using reStructuredText for writing articles and pages, you can include
* This theme sets identifiers for each article's comment threads. If you are switching from a theme that doesn't (such as the Pelican built-in default) this will result in existing comments getting lost. To prevent this, set DISQUS_NO_ID to _True_.
* Set DISQUS_ID_PREFIX_SLUG to _True_ if you have configured your article URLs such that the slug alone will likely not be unique. Ignored if DISQUS_NO_ID is _True_.
* You can also enable Disqus comments for pages. This is a per-page setting you can control by adding a field `comments` to you pages' metadata. Set it to _enabled_ to enable comments for that page. Comment-threads for pages will have an id that is prefixed by 'page-'.
* To show Disqus comment counts on the index page, set DISQUS_DISPLAY_COUNTS to _True_.
### Content license
@@ -158,30 +200,48 @@ The theme can show your most recently active GitHub repos in the sidebar. To ena
* `GITHUB_SKIP_FORK`
* `GITHUB_SHOW_USER_LINK`
### Bootswatch and other Bootstrap 3 themes
### Facebook Open Graph
I included all the lovely Bootstrap 3 themes from [Bootswatch](http://bootswatch.com/), built by [Thomas Park](https://github.com/thomaspark). You can tell Pelican what Bootswatch theme to use, by setting `BOOTSTRAP_THEME` to the desired theme, in lowercase (ie. 'readable' or 'cosmo' etc.). My own site is using _Readable_. If you want to use any other Bootstrap 3 compatible theme, just put the minified CSS in the `static/css` directory and rename it using the following naming scheme: `bootstrap.{theme-name}.min.css`. Then update the `BOOTSTRAP_THEME` variable with the _theme-name_ used.
In order to make the Facebook like button and other social sharing options work better, the template contains Open Graph metatags like `<meta property="og:type" content="article"/>`. You can disable them by setting `USE_OPEN_GRAPH` to _False_. You can use `OPEN_GRAPH_FB_APP_ID` to provide a Facebook _app id_.
You can also provide a default image that will be passed as an Open Graph tag by setting `OPEN_GRAPH_IMAGE` to a relative file path, which will be prefixed by your site's base url. Optionally, you can override this default image on a per article and per page basis, by setting the `og_image` variable in an article or page.
#### Update: Readable has seen some major changes. I added the new version as 'readable' and renamed the old version to 'readable-old'. Update your config accordingly.
### Twitter Cards
The theme supports [Summary Twitter Cards](https://dev.twitter.com/docs/cards/types/summary-card). To activate the necessary tags set `TWITTER_CARDS` to `True`. Because _Twitter Cards_ also use Open Graph tags to identify some of the necessary metadata, `USE_OPEN_GRAPH` must also be set to `True` (which is the default).
You can optionally provide a `TWITTER_USERNAME` which will be used to set the Twitter username for the site and for the content creator.
The same image options for Open Graph (see above) can be used for setting images that appear on Twitter Cards. So if you have set an `OPEN_GRAPH_IMAGE` and optionally `og_image` for articles and/or pages, you're good to go for Twitter Cards as well.
### Twitter Timeline
The theme can show your twitter timeline in the sidebar. To enable, provide a `TWITTER_USERNAME` and a `TWITTER_WIDGET_ID`.
To get a `TWITTER_WIDGET_ID`, go to: https://twitter.com/settings/widgets and select `Create new`. You'll find the TWITTER_WIDGET_ID under the html or in the site url:
`https://twitter.com/settings/widgets/TWITTER_WIDGET_ID/edit`
### AddThis
You can enable sharing buttons through [AddThis](http://www.addthis.com/) by setting `ADDTHIS_PROFILE` to your AddThis profile-id. This will display a **Tweet**, **Facebook Like** and **Google +1** button under each post.
### Facebook Open Graph
In order to make the Facebook like button work better, the template contains Open Graph metatags like `<meta property="og:type" content="article"/>`. You can disable them by setting `USE_OPEN_GRAPH` to _False_. You can use `OPEN_GRAPH_FB_APP_ID` to provide a Facebook _app id_. You can also provide a default image that will be passed to Facebook for the homepage of you site by setting `OPEN_GRAPH_IMAGE` to a relative file path, which will be prefixed by your site's static directory.
* AddThis automatically adds a short hashtag to the end of your URLs. This lets you reveal how often visitors copy your URL from their address bar to share. Example of URL: `http://domain.com/page.html#UF0983`. This function can be disabled by setting `ADDTHIS_DATA_TRACK_ADDRESSBAR` to _False_.
* All social buttons are enabled by default. You can disable certain button by setting following properties to _False_: `ADDTHIS_FACEBOOK_LIKE`, `ADDTHIS_TWEET`, `ADDTHIS_GOOGLE_PLUSONE`.
### Footer
The footer will display a copyright message using the AUTHOR variable and the year of the latest post. If a content license mark is enabled (see above), that will be shown as well.
## Live example
[This is my website](http://dandydev.net)
If you want more examples of what you could do with this theme, have a [look here](EXAMPLES.md).
## Screenshot
![](screenshot.png)
![](screenshot-article.png)
## Live example
[This is my website](http://dandydev.net)

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.
Oops, something went wrong.

0 comments on commit 352965e

Please sign in to comment.