Colophon
########

:title: Colophon
:slug: colophon
:author: Chris Ramsay
:summary: All about how this site is made
:status: published
:show_source: True

Whilst all the content is my own, I owe a debt of gratitude to many others for
everything else:

Site
^^^^

This is a static HTML site created using `Alexis Métaireau's`_ `Pelican`_ static
blog generator with all items starting their life written in
`reStructuredText`_.

Theme
^^^^^

Using `Daan Debie's`_ `pelican-Bootstrap3`_. I would recommend this as it is
very extensible and full of useful configurations options - in short, it is
awesome!

In addition because this theme supports `bootswatch`_ I am using
`Thomas Park's`_ `simplex`_ bootstrap theme extension.

Pelican Plugins
^^^^^^^^^^^^^^^

Related Posts
    In order to manage related posts I am using `related_posts`_ plugin written
    by `Talha Mansoor`_.

Google Sitemaps
    Generating Google sitemaps is done automatically on build using the
    `sitemap`_ plugin written by `Vincent Prouillet`_.

Summaries
    The post summaries are managed by the `summary`_ plugin, created by
    `Elmer de Looff`_.

Math Render
    `This plugin`_, written by `Barry Steyn`_, enables the use of the `MathJax`_
    javascript engine to render any standard :math:`{\LaTeX}` mathematical
    markup as beautifully displayed formulae.

Series
    Project pages are kept linked together in series with `Leonardo Giordani's`_
    very useful `Series`_ plugin.

Tag Cloud
    `As of version 3.6, Pelican's`_ tag clouds are now rendered by a `separate plugin`_
    created by `Lukas Winkler`_.

Tipue Search
    The search function on this site uses the `tipue_search`_ plugin written
    by `Talha Mansoor`_.

Show Source
    A plugin developed by me, and `written about here`_ to enable the source of
    posts to be viewed.

Build
^^^^^

I've since moved on from using `Vagrant`_ and am now using a `Docker machine`_,
specifically an image I have created myself (`chrisramsay/docker-pelican`_),
to run a `Python`_ environment and a customised `Fabric`_ script to manage the
whole author/build/publish process.

Hosting
^^^^^^^

This site is hosted using S3 and distributed via Cloudfront. The build system and site backup is hosted privately at
`Bitbucket`_.

.. _`Daan Debie's`: http://dandydev.net/
.. _`Alexis Métaireau's`:  http://blog.notmyidea.org/
.. _`Pelican`: http://blog.getpelican.com/
.. _`Docker machine`: https://www.docker.com/
.. _`chrisramsay/docker-pelican`: https://hub.docker.com/r/chrisramsay/docker-pelican/
.. _`reStructuredText`: http://docutils.sourceforge.net/rst.html
.. _`pelican-Bootstrap3`: https://github.com/DandyDev/pelican-bootstrap3
.. _`Vagrant`: https://www.vagrantup.com/
.. _`Python`: https://www.python.org/
.. _`Fabric`: http://www.fabfile.org/
.. _`Bitbucket`: https://bitbucket.org
.. _`related_posts`: https://github.com/getpelican/pelican-plugins/tree/master/related_posts
.. _`Talha Mansoor`: http://oncrashreboot.com/
.. _`sitemap`: https://github.com/getpelican/pelican-plugins/tree/master/sitemap
.. _`Vincent Prouillet`: http://vincent.is/
.. _`summary`: https://github.com/getpelican/pelican-plugins/tree/master/summary
.. _`Elmer de Looff`: http://variable-scope.com/
.. _`bootswatch`: http://bootswatch.com/
.. _`Thomas Park's`: http://thomaspark.me/
.. _`simplex`: http://bootswatch.com/simplex/
.. _`This plugin`: https://github.com/getpelican/pelican-plugins/tree/master/render_math
.. _`Barry Steyn`: http://doctrina.org/
.. _`MathJax`: http://www.mathjax.org/
.. _`Leonardo Giordani's`: http://lgiordani.com/
.. _`Series`: https://github.com/getpelican/pelican-plugins/tree/master/series
.. _`As of version 3.6, Pelican's`: http://docs.getpelican.com/en/3.6.0/faq.html#my-tag-cloud-is-missing-broken-since-i-upgraded-pelican
.. _`separate plugin`: https://github.com/getpelican/pelican-plugins/tree/master/tag_cloud
.. _`Lukas Winkler`: https://www.heroicdebugging.biz/
.. _`tipue_search`: https://github.com/getpelican/pelican-plugins/tree/master/tipue_search
.. _`written about here`: {filename}/software/2016-11-06_the-show-source-pelican-plugin.rst