Permalink
Browse files

Updated pelican-bootstrap to v1.2

  • Loading branch information...
DandyDev committed Jan 27, 2014
1 parent c35cbab commit fd1a4eaba46c1def74bd6905bce15c61bb326ed5
Showing with 3,145 additions and 615 deletions.
  1. +16 −0 pelican-bootstrap3/AUTHORS.md
  2. +16 −0 pelican-bootstrap3/CONTRIBUTING.md
  3. +99 −6 pelican-bootstrap3/README.md
  4. BIN pelican-bootstrap3/screenshot-article.png
  5. BIN pelican-bootstrap3/screenshot.png
  6. +1,338 −0 pelican-bootstrap3/static/css/font-awesome.css
  7. +4 −403 pelican-bootstrap3/static/css/font-awesome.min.css
  8. +0 −69 pelican-bootstrap3/static/css/pygments.css
  9. +59 −0 pelican-bootstrap3/static/css/pygments/autumn.css
  10. +47 −0 pelican-bootstrap3/static/css/pygments/borland.css
  11. +35 −0 pelican-bootstrap3/static/css/pygments/bw.css
  12. +62 −0 pelican-bootstrap3/static/css/pygments/colorful.css
  13. +62 −0 pelican-bootstrap3/static/css/pygments/default.css
  14. +62 −0 pelican-bootstrap3/static/css/pygments/emacs.css
  15. +62 −0 pelican-bootstrap3/static/css/pygments/friendly.css
  16. +70 −0 pelican-bootstrap3/static/css/pygments/fruity.css
  17. +62 −0 pelican-bootstrap3/static/css/pygments/manni.css
  18. +60 −0 pelican-bootstrap3/static/css/pygments/monokai.css
  19. +62 −0 pelican-bootstrap3/static/css/pygments/murphy.css
  20. +70 −0 pelican-bootstrap3/static/css/pygments/native.css
  21. +61 −0 pelican-bootstrap3/static/css/pygments/pastie.css
  22. +59 −0 pelican-bootstrap3/static/css/pygments/perldoc.css
  23. +70 −0 pelican-bootstrap3/static/css/pygments/solarizeddark.css
  24. +70 −0 pelican-bootstrap3/static/css/pygments/solarizedlight.css
  25. +70 −0 pelican-bootstrap3/static/css/pygments/tango.css
  26. +60 −0 pelican-bootstrap3/static/css/pygments/trac.css
  27. +70 −0 pelican-bootstrap3/static/css/pygments/vim.css
  28. +34 −0 pelican-bootstrap3/static/css/pygments/vs.css
  29. +78 −6 pelican-bootstrap3/static/css/style.css
  30. BIN pelican-bootstrap3/static/fonts/FontAwesome.otf
  31. BIN pelican-bootstrap3/static/fonts/fontawesome-webfont.eot
  32. +24 −9 pelican-bootstrap3/static/fonts/fontawesome-webfont.svg
  33. BIN pelican-bootstrap3/static/fonts/fontawesome-webfont.ttf
  34. BIN pelican-bootstrap3/static/fonts/fontawesome-webfont.woff
  35. +2 −0 pelican-bootstrap3/static/js/github.js
  36. +10 −0 pelican-bootstrap3/templates/archives.html
  37. +20 −1 pelican-bootstrap3/templates/article.html
  38. +41 −39 pelican-bootstrap3/templates/base.html
  39. +28 −5 pelican-bootstrap3/templates/categories.html
  40. +10 −1 pelican-bootstrap3/templates/category.html
  41. +4 −3 pelican-bootstrap3/templates/includes/article_info.html
  42. +64 −0 pelican-bootstrap3/templates/includes/cc-license.html
  43. +1 −1 pelican-bootstrap3/templates/includes/comment_count.html
  44. +7 −2 pelican-bootstrap3/templates/includes/comments.html
  45. +17 −11 pelican-bootstrap3/templates/includes/footer.html
  46. +33 −0 pelican-bootstrap3/templates/includes/github-js.html
  47. +2 −37 pelican-bootstrap3/templates/includes/github.html
  48. +13 −0 pelican-bootstrap3/templates/includes/links.html
  49. +20 −0 pelican-bootstrap3/templates/includes/piwik.html
  50. +10 −0 pelican-bootstrap3/templates/includes/related-posts.html
  51. +25 −12 pelican-bootstrap3/templates/includes/sidebar.html
  52. +2 −0 pelican-bootstrap3/templates/includes/translations.html
  53. +2 −3 pelican-bootstrap3/templates/index.html
  54. +13 −1 pelican-bootstrap3/templates/page.html
  55. +10 −1 pelican-bootstrap3/templates/tag.html
  56. +29 −5 pelican-bootstrap3/templates/tags.html
@@ -0,0 +1,16 @@
The primary author of this project is:
- [Daan Debie](https://github.com/DandyDev) aka `DandyDev`
And Pelican Bootstrap 3 would not have been possible without the outstanding contributions of the following fine people:
- [Magnun Leno](https://github.com/magnunleno) aka `magnunleno`
- [Hilmar Lapp](https://github.com/hlapp) aka `hlapp`
- [mwcz](https://github.com/mwcz)
- [Sebastian Kempken](https://github.com/skempken) aka `skempken`
- [Sagar Behere](https://github.com/sagarbehere) aka `sagarbehere`
- [Romulo Jales](https://github.com/romulojales) aka `romulojales`
- [Mike Abrahamsen](https://github.com/mikeabrahamsen) aka `mikeabrahamsen`
(For a full contribution overview [look here](https://github.com/DandyDev/pelican-bootstrap3/graphs/contributors).
If you name is missing, please tell me!)
@@ -0,0 +1,16 @@
# Guidelines For Contributing
- Create a new git branch specific to your change, as opposed to making your commits in the master branch.
- Don't put multiple fixes/features in the same branch / pull request.
- Give a proper description in your pull request of what you're trying to fix.
- First line of your commit message should start with present-tense verb, be 50 characters or less, and include the
relevant issue number(s) if applicable. Example: _Ensure proper PLUGIN_PATH behavior. Refs #428._ If the commit completely
fixes an existing issue or request on the tracker, please use `Fixes #585` or `Fix #585` syntax (so the relevant issue is automatically closed
upon PR merge).
- Make sure that new features are configurable using a theme variable (eg. `DISPLAY_CHUCKNORRIS_ADVICE`). Should default to
_False_, so users will not get any surprises when upgrading.
- If you introduce new theme variables, new behaviour or changes from the default Pelican behaviour, make sure you make
mention of it in the [README](README.md)
- Make sure changes do not break backwards compatibility, especially with regards to settings.
- Only changes that stand to benefit a majority of users or use cases are suitable for contributing back to the main repository. For tweaks that are likely specific to your site or likings, try using `CUSTOM_CSS`.
- If doing so would require a CSS selector that isn't supported by the theme, create a patch that adds the necessary CSS selector, not the CSS tweak.
@@ -1,10 +1,13 @@
# pelican-bootstrap3
This is a Bootstrap 3 theme for Pelican. It's fully responsive. Bootstrap 3 has seen an official, final release now, so I don't expect any breaking changes anymore. I will try to keep it up-to-date.
This is a Bootstrap 3 theme for Pelican. It's fully responsive. Bootstrap 3 has seen an official, final release now, so
I don't expect any breaking changes anymore. I will try to keep it up-to-date.
## NOTE
## CONTRIBUTING
If you want to adjust this theme to your own liking, I encourage you to fork it. This theme has started to gather more and more attention in the form of stars and forks. I'm not seeing much real participation though :) If you make improvements that are useful to others and can make the theme better in general **please don't hesitate to make a pull request**.
If you want to adjust this theme to your own liking, I encourage you to fork it. This theme has started to gather more
and more attention in the form of stars and forks. If you make improvements that are useful to others and can make the
theme better in general **please don't hesitate to make a pull request**. For contributing guidelines, [look here](CONTRIBUTING.md)
## Installation
@@ -27,6 +30,7 @@ This theme honors the following standard Pelican settings:
* `DISPLAY_PAGES_ON_MENU`
* `DISPLAY_CATEGORIES_ON_MENU`
* `MENUITEMS`
* `LINKS` (Blogroll will be put in the sidebar instead of the head)
* Analytics & Comments
* `GOOGLE_ANALYTICS`
* `DISQUS_SITENAME`
@@ -36,6 +40,75 @@ It uses the `tag_cloud` variable for displaying tags in the sidebar. You can con
## Extras
### 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):
```
CUSTOM_CSS = 'static/custom.css'
```
To tell Pelican to copy the relevant file to the desired destination, add the path to `STATIC_PATHS` and the destination to `EXTRA_PATH_METADATA`, like so:
```
# Tell Pelican to add 'extra/custom.css' to the output dir
STATIC_PATHS = ['images', 'extra/custom.css']
# Tell Pelican to change the path to 'static/custom.css' in the output dir
EXTRA_PATH_METADATA = {
'extra/custom.css': {'path': 'static/custom.css'}
}
```
### Pygments
You can choose the syntax highlighting style by using the `PYGMENTS_STYLE` variable to specify one of the built-in Pygments styles. By default the `native` style is used. The following styles are avaiable:
- autumn
- borland
- bw
- colorful
- default
- emacs
- friendly
- fruity
- manni
- monokai
- murphy
- native
- pastie
- perldoc
- solarizeddark
- solarizedlight
- tango
- trac
- vim
- vs
For a demo of the different Pygment styles, have a look [here](http://pygments.org/demo/218030/)
### 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.
By default the `SITENAME` will be shown as well. It's also possible to hide the site name using the `HIDE_SITENAME` flag.
### Breadcrumbs
It's possible to show breadcrumbs in your site using the `DISPLAY_BREADCRUMBS` flag. By default the article category isn't shown in the breadcrumbs, if you wish to enable it, set the `DISPLAY_CATEGORY_IN_BREADCRUMBS` flag to _True_.
### Navbar
If you wish to use the inverse navbar from Bootstrap, set the flag `BOOTSTRAP_NAVBAR_INVERSE` to _True_.
### Related Posts
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.
### Favicon
Set the `FAVICON` option in your `pelicanconf.py`. For example: `FAVICON = 'images/favicon.png'`
### Sidebar options
The following things can be displayed on the sidebar:
@@ -53,10 +126,30 @@ SOCIAL = (('twitter', 'http://twitter.com/DaanDebie'),
* **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**
To remove the sidebar entirely, set `HIDE_SIDEBAR` to _True_.
### reStructuredText styles
If you're using reStructuredText for writing articles and pages, you can include the extra CSS styles that are used by the `docutils`-generated HTML by setting `DOCUTIL_CSS` to True. This can be done as a global setting or setting it in the metadata of a specific article or page.
### Disqus comments
* 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_.
* To show Disqus comment counts on the index page, set DISQUS_DISPLAY_COUNTS to _True_.
### Content license
You can optionally declare a [Creative Commons license](http://creativecommons.org) for the content of your site. It will appear in the site's footer. To enable, use one of the following two ways for configuration.
* To choose the license by name, set `CC_LICENSE` to the common abbreviated name of the license: `"CC-BY"` (require attribution), `"CC-BY-SA"` (require ShareAlike), `"CC-BY-ND"` (NoDerivatives) , `"CC-BY-NC"` (require attribution, no commercial reuse), `"CC-BY-NC-SA"` (require ShareAlike, no commercial reuse), or `"CC-BY-NC-ND"` (NoDerivatives, no commercial reuse).
* Alternatively, choose the licence by features:
* `CC_LICENSE_DERIVATIVES` - `"yes"` if permitted, `"no"` if not permitted, and `"ShareAlike"` if derivatives must be shared under the same terms.
* `CC_LICENSE_COMMERCIAL` - `"yes"` if commercial reuse is permitted, and `"no"` otherwise.
* Optionally, you can include attribution markup in the license mark by setting `CC_ATTR_MARKUP` to _True_.
The license choice mirrors the [Creative Commons License Chooser](http://creativecommons.org/choose/). Source for the macro that renders the mark is at http://github.com/hlapp/cc-tools.
### GitHub
The theme can show your most recently active GitHub repos in the sidebar. To enable, provide a `GITHUB_USER`. Appearance and behaviour can be controlled using the following variables:
@@ -77,11 +170,11 @@ You can enable sharing buttons through [AddThis](http://www.addthis.com/) by set
### 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.
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.
### Footer
The footer will display a copyright message using the AUTHOR variable and the year of the latest post.
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.
## Screenshot
@@ -91,4 +184,4 @@ The footer will display a copyright message using the AUTHOR variable and the ye
## Live example
[This is my website](http://dandydev.net)
[This is my website](http://dandydev.net)
Binary file not shown.
Binary file not shown.
Oops, something went wrong.

0 comments on commit fd1a4ea

Please sign in to comment.