A typeset PDF version of this page is available: Download PDF

Style Specimen¶

A compact page for checking the site’s typography, spacing, colour, and component styling in dark and light mode.

This is not intended as a public demonstration page. It is a small reference page for checking that the theme remains coherent after changes to CSS, templates, or MkDocs configuration.

Heading 1¶

Introductory paragraph text with a standard link, bold text, italic text, and inline code. Text can also be highlighted as required, or even ~~striked~~ from the record.

Heading 2¶

Paragraph text following a second-level heading. This checks the vertical rhythm above and below H2 headings.

Heading 3¶

A smaller heading for local structure.

Heading 4¶

A lower-level heading used occasionally for compact sections.

Heading 5¶

A heading for small text or extra notes.

Heading 6¶

A rarely used small heading

Callouts¶

Note

A general note or clarification.

Information

Some useful information.

Abstract

A compact summary or design principle.

Success

A successful outcome.

Quotation

A short quotation or reflective aside.

Example

An example of some action or operation.

Caution

A stronger visual state for something that needs attention.

Danger

Something to pay attention to now.

Bullet Lists¶

plain text documents
static publishing
private staging
public release

Numbered Lists¶

edit
commit
build
publish

Table¶

Item	Purpose
Markdown	source text
MkDocs	web output
iA Writer	PDF output
Git	history and deployment

Code¶

Inline code should remain readable: publish-mkdocs-site.

~/bin/deploy-mkdocs-site
~/bin/publish-mkdocs-site

Language code blocks¶

A fenced code block with a language label should be syntax highlighted.

def describe_weather(temperature):
    if temperature < 10:
        return "cold"
    if temperature < 20:
        return "mild"
    return "warm"

print(describe_weather(16))

{
  "name": "Example",
  "status": "active",
  "items": ["one", "two", "three"]
}

Inline highlighted code, if enabled, can be written like this: print("hello").

Blockquote¶

Good systems should remain understandable after the tools around them have changed.

Jeremy Worth

A Personal Perspective