{
"info": {
"author": "W. Minchin",
"author_email": "w_minchin@hotmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Framework :: Pelican :: Themes",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.3",
"Programming Language :: Python :: 3.4",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6"
],
"description": "=======\nSeafoam\n=======\n\n.. image:: https://raw.githubusercontent.com/MinchinWeb/seafoam/master/docs/seafoam-logo-4x.png\n :align: center\n :alt: Seafoam Logo\n\n``Seafoam`` is a theme for `Pelican `_,\na static site generator written in Python.\n\nThe ``seafoam`` theme is based on Bootstrap 3, and was first used at\n`Minchin.ca `_. \n\nInstallation\n------------\n\nThe easiest way to install the ``seafoam`` theme is through the use\nof pip. This will also install the required dependencies automatically.\n\n.. code-block:: sh\n\n pip install seafoam\n\nThen, in your ``pelicanconf.py`` file, import the module, use the\nbuilt in function to specify your theme location, set the default\ncolour scheme (more options coming soon), add the required plugins, and set\nthe image processing patterns used:\n\n.. code-block:: python\n\n import seafoam\n\n THEME = seafoam.get_path()\n BOOTSTRAP_THEME = 'seafoam'\n\n PLUGINS = ['minchin.pelican.jinja_filters',\n 'minchin.pelican.plugins.image_process',\n # others, as desired...\n ]\n\n IMAGE_PROCESS = {\n 'article-feature': [\"scale_in 848 848 True\"],\n 'index-feature': [\"scale_in 263 263 True\"],\n }\n\n # Generate 404 error page\n TEMPLATE_PAGES = {\n '404.html': '404.html',\n }\n\n # the rest of the your configuration file...\n\n\nYou will may also need to configure the theme through the use of additional\nsettings (see below).\n\n\nRequirements\n------------\n\n``Seafoam`` requires Pelican and the ``image_process`` and\nthe ``jinja filters`` plugin. If the theme is installed from pip, these\nshould be automatically installed. If needed they can be manually\ninstalled with pip:\n\n.. code-block:: sh\n\n pip install pelican\n pip install minchin.pelican.plugins.image_process\n pip install minchin.pelican.jinja_filters\n\n\nSupported Plugins\n-----------------\n\nSeafoam works with several other plugins for Pelican, but none of those\nlisted in this section are required.\n\n- `readtime `_ -- provides estimated reading time for articles. Available from PyPI as ``pelican-readtime``.\n- `post-stats `_ -- provides estimated reading time for articles if `readtime` is not available. Available in the `Pelican Plugins collection `_.\n- `neighbors `_ -- provides post-article links to the next and previous article on your blog and the next and previous article in that category. Available on PyPI as ``pelican-neighours``.\n- `pelican_comment_system `_ -- add static comments to your blog. Available in the `Pelican Plugins collection `_.\n- `Related Posts `_ -- adds the related_posts variable to the article's context.\n- Tipue Search\n\n\nAdditional Settings\n-------------------\n\nThese settings can be set in your ``pelicanconf.py`` file (your Pelican settings\nfile) to alter the behavior of the theme.\n\nIf a value is given below, this represents the effective default value. If no\nvalue is given, the effective default value is `None`.\n\nIf you are using this theme on a sub-site (i.e a directory of the \"main site\"),\nlook at ``MENUITEMS_2``, ``MENUITEMS_2_AT``, and ``MENUITEMS_2_AT_LINK``\nsettings.\n\nIf you are using this theme on a subdomain, look at the ``SITE_ROOT_URL``\nsetting.\n\nThis documentation has to be manually updated. If the settings no longer match\nthe theme's behavior, or a setting is missing from here, please open a ticket\non `GitHub `_.\n\n.. use the \".. data::\" directive here for Sphinx output, but on GitHub, that just causes everything to disappear\n\nABOUT_ME\n You can show a short blurb of text about yourself and a picture. This setting\n is the paragraph. Raw HTML is accepted. See the ``AVATAR`` setting to set the\n picture.\nADAM\n These ADAM settings were originally set up to support my genealogy sub-site\n (the original name of the the pre-processor I was using as called \"Adam\"). If\n this is set to ``False``, the rest of the ADAM_* settings won't be active.\n These settings are probably generic enough that you could use these for any\n generator or outside program used to help generate your site.\nADAM_COPY_DATE\n Override the copyright date in the footer. (Provide a string).\nADAM_FOOTER\n An extra \"page footer\" to apply to all pages. (Provide an HTML string.)\nADAM_LINK\n Link target for the Adam version text.\nADAM_UPDATED\n Override the updated date.\nADAM_VERSION\n Reported name and version of \"Adam\". \nADDTHIS_PROFILE\n You can enable sharing buttons through `AddThis `_\n by this setting to your AddThis profile-id. This will display a Tweet,\n Facebook Like and Google +1 button under each post.\nARCHIVES_URL\n Same as the regular Pelican setting.\nASSET_CSS\n Set to ``True`` if you want the ``asset`` plugin to compile your CSS.\nASSET_JS\n Set to ``True`` if you want the ``asset`` plugin to compile your Javascript.\nAUTHOR\n Who to list as the copyright belonging to in the site footer.\nAUTHORS_URL\n Same as the regular Pelican setting.\nAVATAR\n You can show a short blurb of text about yourself and a picture. This setting\n is the path to the picture. See the ``ABOUT_ME`` setting to set the\n descriptive paragraph.\nBOOTSTRAP_NAVBAR_INVERSE = False\n Apply inverse CSS setting to Navbar.\nBOOTSTRAP_THEME\n Set this to `seafoam`. Other values (including leaving this unset) are not\n expected to work correctly.\nCATEGORIES_URL\n Same as the regular Pelican setting.\nCATEGORY_IMAGES\n Provide a default featured image by category. If an image is set in the\n article metadata, that will override this.\n\n Provide a dictionary where the key is the category name and the value is the\n path of the image, relative to the SITEURL.\nCC_ATTR_MARKUP\n Optionally, you can include attribution markup in the CC license mark by\n setting this to ``True``.\nCC_LICENSE\n Set a site-wide Creative Commons License by specify the \"short name\" of the\n license (like ``CC_BY``, or ``CC-BY-NC-ND``). Alternately, use\n ``CC_LICENSE_COMMERCIAL`` and ``CC_LICENSE_DERIVATIVES`` to \"build a\n license\".\nCC_LICENSE_COMMERCIAL\n \"yes\" if commercial use is permitted, \"no\" otherwise. Use this in lieu of\n ``CC_LICENSE`` and in combination with ``CC_LICENSE_DERIVATIVES`` to \"build a\n license\".\nCC_LICENSE_DERIVATIVES\n \"yes\" is derivatives are permitted, \"no\" otherwise. Use this in lieu of\n ``CC_LICENSE`` and in combination with ``CC_LICENSE_COMMERCIAL`` to \"build a\n license\".\nCUSTOM_CSS\n Link, relative to SITEURL, to a custom CSS file.\nCUSTOM_CSS_LIST\n Custom CSS to load; can be either absolute links, or relative links. If the\n listed item starts with ``//``, ``http://``, ``https://``, it is assumed to\n be absolute link and added as-is to the markup. Otherwise, the link is\n assumed to be relative to SITEURL.\nCUSTOM_JS_LIST\n Custom Javascript to load; can be either scripts, absolute links, or relative\n links. If the listed item starts with ``