35 lines
1.9 KiB
Markdown
35 lines
1.9 KiB
Markdown
|
# style guide
|
||
|
|
Having a consistent design language is very important to me. This document lays
|
||
|
|
out specific stylistic rules for pages on this site. Human error is always a
|
||
|
|
factor, and so these rules are more prescription than description
|
||
|
|
## headings
|
||
|
|
One heading should appear at the top of every page. Text should contain only
|
||
|
|
lowercase ascii alphabetic characters. It should represent the title of the
|
||
|
|
page, and match the URL tail (substituting spaces for hyphens, and sans
|
||
|
|
file extension)
|
||
|
|
## subheadings
|
||
|
|
Pages may have any number of subheadings under the top level heading. Text
|
||
|
|
should contain only lowercase ascii alphabetic characters. A subheading must
|
||
|
|
never be immediately followed by another subheading
|
||
|
|
## paragraphs
|
||
|
|
Paragraph text should be written in complete grammatically correct sentences,
|
||
|
|
and may use any non-emoji unicode characters. The last sentence in a paragraph
|
||
|
|
should not end in a period if the paragraph is followed by anything other than
|
||
|
|
another paragraph
|
||
|
|
## hyperlinks
|
||
|
|
Hyperlinks may appear inline in any text other than headings and subheadings.
|
||
|
|
The hyperlink text should be descriptive of the page it is linking to, and
|
||
|
|
never the same as the link itself (e.g. [logan's site](/) not
|
||
|
|
[https://lgatlin.dev/](/)). Internal links should have the same text as the
|
||
|
|
page title they link to. Hyperlinks should be used liberally, and regularly
|
||
|
|
audited for dead or redirected targets
|
||
|
|
## lists
|
||
|
|
List items should begin with a title that is all lowercase, optionally followed
|
||
|
|
by a hyphen ('-') and a subtitle or attribution. The subtitle or attribution
|
||
|
|
should start with a capital letter and contain no punctuation
|
||
|
|
## collage
|
||
|
|
A collage consists of a set of images, optionally with a title and subtitle
|
||
|
|
below each image. Collages should not be on a fixed grid, and should rearrange
|
||
|
|
themselves to best fit the screen dimensions. Image titles may contain
|
||
|
|
hyperlinks, but images may never be hyperlinks themselves
|