seafoam


Nameseafoam JSON
Version 2.0.4 PyPI version JSON
home_pagehttps://github.com/MinchinWeb/seafoam
SummaryPelican theme, first used for Minchin.ca.
upload_time2017-01-11 20:34:31
maintainer
docs_urlNone
authorW. Minchin
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
Coveralis test coverage No Coveralis.
            =======
Seafoam
=======

.. image:: https://raw.githubusercontent.com/MinchinWeb/seafoam/master/docs/seafoam-logo-4x.png
    :align: center
    :alt: Seafoam Logo

``Seafoam`` is a theme for `Pelican <http://docs.getpelican.com/>`_,
a static site generator written in Python.

The ``seafoam`` theme is based on Bootstrap 3, and was first used at
`Minchin.ca <http://minchin.ca>`_. 

Installation
------------

The easiest way to install the ``seafoam`` theme is through the use
of pip. This will also install the required dependencies automatically.

.. code-block:: sh

  pip install seafoam

Then, in your ``pelicanconf.py`` file, import the module, use the
built in function to specify your theme location, set the default
colour scheme (more options coming soon), add the required plugins, and set
the image processing patterns used:

.. code-block:: python

  import seafoam

  THEME = seafoam.get_path()
  BOOTSTRAP_THEME = 'seafoam'

  PLUGINS = ['minchin.pelican.jinja_filters',
             'minchin.pelican.plugins.image_process',
             # others, as desired...
             ]

  IMAGE_PROCESS = {
    'article-feature': ["scale_in 848 848 True"],
    'index-feature': ["scale_in 263 263 True"],
  }

  # the rest of the your configuration file...


You will may also need to configure the theme through the use of additional
settings (see below).


Requirements
------------

``Seafoam`` requires Pelican and the ``image_process`` and
the ``jinja filters`` plugin. If the theme is installed from pip, these
should be automatically installed. If needed they can be manually
installed with pip:

.. code-block:: sh

   pip install pelican
   pip install minchin.pelican.plugins.image_process
   pip install minchin.pelican.jinja_filters


Additional Settings
-------------------

Details coming. In the meantime, refer to the settings on the `Bootstrap 3
theme <https://github.com/getpelican/pelican-themes/tree/master/pelican-bootstrap3>`_.


Credits
-------

Original theme developed by `Daan Debie <http://dandydev.net/>`_.

The idea that a theme could be installed as a Python package by `Jeff
Forcier <http://bitprophet.org/>`_'s `Alabaster theme
<https://github.com/bitprophet/alabaster>`_ for Sphinx.
            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "coveralis": false, 
    "keywords": "", 
    "upload_time": "2017-01-11 20:34:31", 
    "author": "W. Minchin", 
    "home_page": "https://github.com/MinchinWeb/seafoam", 
    "github_user": "MinchinWeb", 
    "download_url": "https://pypi.python.org/packages/fb/fd/079465faf5815f0c4c74bc6cbbd517a68662dc6122fb681cda9192615027/seafoam-2.0.4.tar.gz", 
    "platform": "UNKNOWN", 
    "version": "2.0.4", 
    "cheesecake_documentation_id": null, 
    "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 <http://docs.getpelican.com/>`_,\na static site generator written in Python.\n\nThe ``seafoam`` theme is based on Bootstrap 3, and was first used at\n`Minchin.ca <http://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  # 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\nAdditional Settings\n-------------------\n\nDetails coming. In the meantime, refer to the settings on the `Bootstrap 3\ntheme <https://github.com/getpelican/pelican-themes/tree/master/pelican-bootstrap3>`_.\n\n\nCredits\n-------\n\nOriginal theme developed by `Daan Debie <http://dandydev.net/>`_.\n\nThe idea that a theme could be installed as a Python package by `Jeff\nForcier <http://bitprophet.org/>`_'s `Alabaster theme\n<https://github.com/bitprophet/alabaster>`_ for Sphinx.", 
    "lcname": "seafoam", 
    "bugtrack_url": null, 
    "github": true, 
    "name": "seafoam", 
    "license": "", 
    "travis_ci": false, 
    "github_project": "seafoam", 
    "summary": "Pelican theme, first used for Minchin.ca.", 
    "split_keywords": [], 
    "author_email": "w_minchin@hotmail.com", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2017-01-11T20:35:46", 
            "comment_text": "", 
            "python_version": "py3", 
            "url": "https://pypi.python.org/packages/1a/b7/7e2c79504baa1c14f1ccdb1cd487600fee237f0aa2fc5f16f2cec269895a/seafoam-2.0.4-py3-none-any.whl", 
            "md5_digest": "6d25b51d2b8309537c66068c186d7f13", 
            "downloads": 0, 
            "filename": "seafoam-2.0.4-py3-none-any.whl", 
            "packagetype": "bdist_wheel", 
            "path": "1a/b7/7e2c79504baa1c14f1ccdb1cd487600fee237f0aa2fc5f16f2cec269895a/seafoam-2.0.4-py3-none-any.whl", 
            "size": 1437928
        }, 
        {
            "has_sig": false, 
            "upload_time": "2017-01-11T20:34:31", 
            "comment_text": "", 
            "python_version": "source", 
            "url": "https://pypi.python.org/packages/fb/fd/079465faf5815f0c4c74bc6cbbd517a68662dc6122fb681cda9192615027/seafoam-2.0.4.tar.gz", 
            "md5_digest": "b404f4fe346b236d8687556bdae099a4", 
            "downloads": 0, 
            "filename": "seafoam-2.0.4.tar.gz", 
            "packagetype": "sdist", 
            "path": "fb/fd/079465faf5815f0c4c74bc6cbbd517a68662dc6122fb681cda9192615027/seafoam-2.0.4.tar.gz", 
            "size": 1357594
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}