diff options
Diffstat (limited to 'pelican-bootstrap3/README.md')
| -rw-r--r-- | pelican-bootstrap3/README.md | 66 |
1 files changed, 44 insertions, 22 deletions
diff --git a/pelican-bootstrap3/README.md b/pelican-bootstrap3/README.md index 61b8829..da8955d 100644 --- a/pelican-bootstrap3/README.md +++ b/pelican-bootstrap3/README.md @@ -43,13 +43,11 @@ It uses the `tag_cloud` variable for displaying tags in the sidebar. You can con ### 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. +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 _Simplex_. 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. ### 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. +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. Set `SHOW_DATE_MODIFIED` to True to show the article modified date next to the published date. ### Custom CSS @@ -103,6 +101,10 @@ For a demo of the different Pygment styles, have a look [here](http://pygments.o 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`. +### Bootstrap fluid layout + +If you'd like to use the fluid container layout from Bootstrap, set the flag `BOOTSTRAP_FLUID` 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. @@ -121,16 +123,6 @@ 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. -### Series - -This theme supports the [Series plugin](https://github.com/getpelican/pelican-plugins/tree/master/series). If you enable the plugin you will find in the footer the links to the previous and next articles in the series. - -You may customize the header of this list setting the `SERIES_TEXT` variable, which can also include the `index` and `name` variables. The first is the index of the current article in the series (starting from 1) and the second is the name of the series. The default string is `Part %(index)s of the %(name)s series`. - -You may display on the sidebar the link to the previous and next article in the series setting `DISPLAY_SERIES_ON_SIDEBAR` to `True`. - -You may display information on the series just under the article title setting `SHOW_SERIES` to `True`. - ### 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. @@ -141,7 +133,7 @@ Set the `FAVICON` option in your `pelicanconf.py`. For example: `FAVICON = 'imag ### 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). +* 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 @@ -159,6 +151,14 @@ You can show a short blurb of text about yourself and a picture. The following t * 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') +### Banner Image + +A banner image can be added to the theme, displayed with the SITENAME and an optional subtitle. Config options are as follows: + +* Set the banner image with `BANNER = '/path/to/banner.png'` +* Set the subtitle text with `BANNER_SUBTITLE = 'This is my subtitle'` +* By default, the banner is only shown on the index page. To display the banner on all pages, set `BANNER_ALL_PAGES = True` + ### Sidebar options The following things can be displayed on the sidebar: @@ -197,7 +197,7 @@ You can optionally declare a [Creative Commons license](http://creativecommons.o * 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. + * `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. @@ -210,13 +210,9 @@ The theme can show your most recently active GitHub repos in the sidebar. To ena * `GITHUB_SKIP_FORK` * `GITHUB_SHOW_USER_LINK` -### Coderwall Badges - -The theme can show your [Coderwall](https://coderwall.com/) badges in the sidebar. To enable, provide a `CODERWALL_USER`. - ### Facebook Open Graph -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_. +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. ### Twitter Cards @@ -242,9 +238,35 @@ You can enable sharing buttons through [AddThis](http://www.addthis.com/) by set * 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`. +### Shariff + +As an alternative, you may use [Shariff](https://github.com/heiseonline/shariff) by setting `SHARIFF = True`. This will display the privacy enabled social media buttons developed by [heiseonline](https://github.com/heiseonline). + + * By default, `data-url` is set to the URL of the current article. + * To customize the social media buttons, set + * `SHARIFF_BACKEND_URL` (see [Shariff Backends](https://github.com/heiseonline/shariff#backends)) + * `SHARIFF_LANG` (`de` (default), `en` or `fr`) + * `SHARIFF_ORIENTATION` (`horizontal` (defualt) or `vertical`) + * `SHARIFF_SERVICES` (default: `["facebook","googleplus"]`) + * `SHARIFF_THEME` (`standard` or `gray`) + * `SHARIFF_TWITTER_VIA` (`True`/`False`, uses `TWITTER_USERNAME`) + +For a detailed description of each setting, refer to [data attributes](https://github.com/heiseonline/shariff#options-data-attributes) description at the [Shariff README](https://github.com/heiseonline/shariff). + +### Tipue Search + +This theme has support for the +[Tipue Search plugin](https://github.com/getpelican/pelican-plugins/tree/master/tipue_search). + +All you have to do, is: +- enable the plugin, and the theme will add a search box on the right + side of the menu +- Add `DIRECT_TEMPLATES = (('search',))` in your `pelicanconf.py`. + + ### 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. +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 |