This repository contains raw Markdown files that can be rendered using a static site generator.
It is contained in a separate repository to provide a cleaner change history and a permanent archive of content, divorced from any presentation.
The presentation of content is improved if the chosen Markdown library is configured to recognise the following extensions.
Abbreviations (with expansions to be included in the title
attribute) are marked down as follows:
It was nearly 20 years after the launch of BBC Television, that its first full-time graphic designer was employed, John Sewell, in 1954.
*[BBC]: British Broadcasting Corporation
<p>It was nearly 20 years after the launch of <abbr title="British Broadcasting Corporation">BBC</abbr> Television, that its first full-time graphic designer was employed, John Sewell, in 1954.</p>
Class names are provided via attributes. Classes for inline elements are marked down as follows:
A paragraph with **inline**{.foo} content.
<p>A paragraph with <em class="foo">inline</em> content.</p>
For classes on block level content, the attribute is given on the immediately following line:
Paragraph
{.bar}
<p class="bar">Paragraph</p>
See Markdown classes.
Block quotes with attribution are marked down as follows:
> It has received lots of fan mail and correspondence. We will definitely be renewing its contract.
> — Lambie-Nairn, 1997, p122
<figure>
<blockquote>
<p>It has received lots of fan mail and correspondence. We will definitely be renewing its contract.</p>
</blockquote>
<figcaption>Crook, 1986</figcaption>
</figure>
To indicate a span of text which should have attributes applied, but doesn’t have an appropriate inline syntax available, square brackets are used:
A paragraph with [inline]{.foo} content.
<p>A paragraph with <span class="foo">inline</span> content.</p>
Titles of cited works are marked down as follows:
""Everything Everywhere All at Once"" is the multiverse done right.
<p><cite>Everything Everywhere All at Once</cite> is the multiverse done right.</p>
Code blocks with syntax highlighting use three backticks (```
) on the lines before and after the code block. The syntax used is indicated by the file extension shown after the first three backticks:
```js
console.log("hello world");
```
A description list with child terms and details are marked down as follows:
Term 1
: Definition 1
Term 2 with _inline markup_
: Definition 2
<dl>
<dt>Term 1</dt>
<dd>Definition 1</dd>
<dt>Term 2 with <em>inline markup</em></dt>
<dd>Definition 2</dd>
</dl>
Footnotes are marked down as follows:
If you’ve been considering making the switch, here are a few tips and tricks to help you on your way[^1].
[^1]: Information provided is correct as of Eleventy v0.6.0 and Jekyll v3.8.5
<p>If you’ve been considering making the switch, here are a few tips and tricks to help you on your way<sup class="footnote-ref"><a href="#fn1" id="fnref1">1</a></sup>.</p>
<section aria-label="footnotes">
<aside id="fn1">
<p>Information provided is correct as of Eleventy v0.6.0 and Jekyll v3.8.5 <a href="#fnref1">↩︎</a></p>
</aside>
</section>
Images can be found in the media
folder, with paths using the following convention:
/media/{:year}/{:day}/{:post-type-prefix}{:type-index}/{filename}
Use the #screenshot
fragment to indicate that an image should be displayed as a screenshot. For example:
/media/projects/bradshaws_guide/homepage.png#screenshot
Although Markdown defines the content in quotes after the filename as the title for the image, it’s intended for this content to be shown in a figure caption:
![A small yellow boat sits below the Dom Luís I Bridge during golden hour.](/media/2022/241/a1/image.jpg "Dom Luís I Bridge, Porto.")
<figure>
<img src="/media/2022/241/a1/image.jpg" alt="A small yellow boat sits below the Dom Luís I Bridge during golden hour.">
<figcaption>Dom Luís I Bridge, Porto.</figcaption>
</figure>
Use unordered lists with an image or figure as the only item contained within each list item. Ensure each list item is separated by two line breaks to ensure compatibility when rendering figures with captions.
- ![Green and yellow heather below frost-covered trees.](/media/2023/236/a1/como-dome.jpg "Dome of Cattedrale di Santa Maria Assunta, Como.")
- ![A path stretches into a distance towards woodland.](/media/2023/236/a1/brunate-dome.jpg "Dome of Chiesa di Sant’Andrea Apostolo, Brunate.")
<ul>
<li>
<figure>
<img src="/media/2023/236/a1/como-dome.jpg" alt="Green and yellow heather below frost-covered trees.">
<figcaption>Dome of Cattedrale di Santa Maria Assunta, Como.</figcaption>
</figure>
</li>
<li>
<figure>
<img src="/media/2023/236/a1/brunate-dome.jpg" alt="A path stretches into a distance towards woodland.">
<figcaption>Dome of Chiesa di Sant’Andrea Apostolo, Brunate.</figcaption>
</figure>
</li>
</ul>
External videos are provided as links to the websites hosting them:
[Paul McCartney - I’ve Got a Feeling (feat. John Lennon)](https://www.youtube.com/watch?v=g4UsXksoGNg)
It is up to the host renderer if or how these links are enhanced or displayed.
Maps can be implemented as either static or interactive maps. If a post includes a map, GeoJSON data is provided in the posts front matter (typically under the geojson
key).
This data can be used to generate static map images (previously generated images are saved in the media
folder) or used to build interactive map tiles.
The following utility classes are used (provided via attributes) to indicate the presentation of certain content:
align-bleed
Content should take up full available width of its containeralign-pull
Content should be pulled to one side of its container