aboutsummaryrefslogtreecommitdiffstats
path: root/pelican-bootstrap3/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'pelican-bootstrap3/README.md')
-rw-r--r--pelican-bootstrap3/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/pelican-bootstrap3/README.md b/pelican-bootstrap3/README.md
index 0e9924b..a2a17f5 100644
--- a/pelican-bootstrap3/README.md
+++ b/pelican-bootstrap3/README.md
@@ -121,6 +121,16 @@ 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.