{ "info": { "author": "Jonathan Sharpe", "author_email": "mail@jonrshar.pe", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Framework :: Pelican :: Themes", "License :: OSI Approved :: ISC License (ISCL)", "Programming Language :: Python :: 3 :: Only" ], "description": "Bulrush\n=======\n\nA [Bulma][1]-based [Pelican][2] blog theme; clean, flexible and responsive.\n\n ![Screenshot - Bulrush at 1440px][13]\n\nThe icons are from [Font Awesome][3] by Dave Gandy. The pure HTML/CSS \"Fork me\non GitHub\" ribbon is based on [`github-fork-ribbon-css`][4] by Simon Whitaker; I\nmodified it to be flatter.\n\nFeatures\n--------\n\n - [x] **Responsive design** - four column layout on desktop (\u2265980px), three column\non tablet (\u2265769px), single column on mobile. Tabbed navigation bar collapses\ninto drop-down \"burger menu\" on mobile.\n\n - [x] **Meta tagging functionality** - support for [Open Graph][5] and [Twitter\nCards][6] meta tags, giving enhanced display when sharing articles on social\nmedia sites (**note**: *currently only available for [articles and pages][7]*).\n\n - [x] **Printable layouts** - the navigation is hidden when printed, avoiding\nwasted space.\n\n - [x] **Custom styling** - additional CSS files can be included to customise\nthe default styling.\n\n - [x] **Service integrations** - including Disqus, GitHub, Google Analytics\nand MailChimp.\n\n - [x] **PyPI package available** - so it can be `pip install`-ed.\n\nInstallation\n------------\n\nBulrush is available via the [Python Package Index][22], so you can install it\nwith:\n\n```bash\npip install bulrush\n```\n\nThe main exports from the module are:\n\n - `PATH`: the path to the theme;\n - `FILTERS`: the additional Jinja filters used by the theme; and\n - `ENVIRONMENT`: the Jinja environment required by the theme.\n\nYou can use them in your `pelicanconf.py` as follows:\n\n```python\nimport bulrush\n\nTHEME = bulrush.PATH\nJINJA_ENVIRONMENT = bulrush.ENVIRONMENT\nJINJA_FILTERS = bulrush.FILTERS\n```\n\n### Other Requirements\n\nYou need to make the appropriate Pelican plugin, [`assets`][15], available. One\nway of achieving this is to make the `pelican-plugin` repository a submodule of\nyour site, then you can add to your `pelicanconf.py`:\n\n```python\nPLUGIN_PATHS = ['pelican-plugins']\nPLUGINS = ['assets']\n```\n\n**Note**: referencing the Pelican plugins in this way may have implications for\nthe license of your project. See https://github.com/textbook/bulrush/issues/17.\n\n### Alternative\n\nIf you don't want to install the theme from PyPI you can simply give Pelican a\nrelative path to the inner `bulrush/` directory. For example, add `bulrush` as\na submodule and set:\n\n```python\nTHEME = 'bulrush/bulrush'\n```\n\nIn this case you will need to configure the environment and filters yourself\nand ensure that `webassets` *is* installed from PyPI.\n\nAdditional Screenshots\n----------------------\n\n - 480 x 480px (mobile):\n\n ![Screenshot - Bulrush at 480px][11]\n\n - 840 x 480px (tablet):\n\n ![Screenshot - Bulrush at 840px][12]\n\n - 980 x 480px (desktop):\n\n ![Screenshot - Bulrush at 980px][10]\n\nSettings\n--------\n\nAs well as the [basic settings][14], Bulrush supports the following options in\nyour `pelicanconf.py`:\n\n| Setting name | What does it do? |\n| --- | --- |\n| `DISQUS_SITENAME` | Enables Disqus comments. Note that you should set up the full Comment Count Link, as no additional text is applied. |\n| `GITHUB_URL` | Enables the \"Fork me on GitHub\" ribbon. |\n| `GOOGLE_ANALYTICS` | Set to `\u2018UA-XXXX-YYYY\u2019` to activate Google Analytics. |\n| `LICENSE` | A string or dictionary describing the license for the site; see details below. |\n| `LINKS` | A list of tuples `('Title', 'URL')` for links to appear in the \"blogroll\" section of the sidebar. |\n| `MAILCHIMP` | Configure to activate a [MailChimp][20] sign-up form; see details below. |\n| `MENUITEMS` | A list of tuples `('Title', 'URL')` for items to appear in the tabbed navigation. |\n| `SITESUBTITLE` | A subtitle to appear in the header. |\n| `SOCIAL` | A list of tuples `('Title', 'URL')` to appear in the \"social\" section of the sidebar. |\n| `TWITTER_USERNAME` | Enables Twitter meta-tags in the article and page headers. |\n\nIf `DISPLAY_CATEGORIES_ON_MENU` is omitted or set explicitly to `True`, the\ncategories are shown in the tabbed navigation with any `MENUITEMS`. If\n`DISPLAY_PAGES_ON_MENU` is omitted or set explicitly to `True`, they are listed\nin the sidebar with any `SOCIAL` or other `LINKS`.\n\n### Social Links\n\nAppropriate icons are provided in the sidebar for a range of sites in the\n`SOCIAL` link list. Have a look in [`social.html`][17] to see which titles this\napplies to. If none of the sites are a match, then:\n\n - if the second, URL element in the tuple starts with `'mailto:'`, an envelope\n icon is used; otherwise\n - a globe icon is used.\n\n ![Screenshot - Social icons in sidebar][24]\n\n### MailChimp Configuration\n\nIf you're using [MailChimp][20] to handle a mailing list for your blog, you\ncan configure a subscription form in the sidebar. You need to set three values\nto enable this, which you can get from [the signup form creator][21]. Simply\nlook for the form action:\n\n```html\n