diff options
Diffstat (limited to 'pelican-bootstrap3/README.md')
| -rw-r--r-- | pelican-bootstrap3/README.md | 80 |
1 files changed, 70 insertions, 10 deletions
diff --git a/pelican-bootstrap3/README.md b/pelican-bootstrap3/README.md index 2535f81..0e9924b 100644 --- a/pelican-bootstrap3/README.md +++ b/pelican-bootstrap3/README.md @@ -32,7 +32,8 @@ 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` @@ -40,6 +41,16 @@ It uses the `tag_cloud` variable for displaying tags in the sidebar. You can con ## 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   -## Live example -[This is my website](http://dandydev.net) |