
.. _oleb:

=====
Ole B
=====

**Ole B** is a bright, simple theme based on Ole Begemann's design for `<http://oleb.net>`_,
created with his permission. The theme was written from scratch by `Tyler Butler <http://tylerbutler.com>`_ using
Ole's site as a reference.

.. note::
   By default :ref:`oleb` uses several fonts available at TypeKit. These fonts are available as part of TypeKit's
   trial plan.

Settings
========

Ole B supports the following settings which can be configured using the
:attr:`~engineer.conf.EngineerConfiguration.THEME_SETTINGS` setting.

``typekit_id``
    The ID of the TypeKit kit that should be used. Ole B uses specific fonts that should be included in the kit.

``twitter_id``
    The username of the Twitter user whose feed should be shown in the sidebar. *Defaults to tylerbutler if not
    provided.*

``tweet_count``
    The number of tweets to include in the Twitter sidebar. *Defaults to 4 if not provided.*


Fonts
=====

Ole B requires the following fonts:

- `Museo Slab <https://typekit.com/fonts/museo-slab>`_
- `Museo Sans <https://typekit.com/fonts/museo-sans>`_


Templates
=========

Required Templates and Fragments
--------------------------------

No templates are strictly required for this theme beyond the base :ref:`template fragments` that all Engineer sites
will likely want to provide. In particular, users of the Ole B theme will probably want to create
:file:`_sidebar.html` and :file:`_primary_nav.html` templates.

.. seealso::
   :ref:`template fragments`, :ref:`navigation`, :ref:`sidebar`


.. _oleb inheritable templates:

Inheritable Templates
---------------------

Ole B includes several base templates that sites can inherit from to create :ref:`template pages`.

:file:`template_page_simple`

A simple template page layout that includes the default site sidebar.


Template Fragments
------------------

Ole B does not support any additional :ref:`template fragments` beyond those available for all Engineer sites.


Metadata
========

.. literalinclude:: ../../themes/oleb/metadata.yaml
   :language: yaml
