Style Guide

25 Apr, 2022

---

This is my personal style guide which can be adopted as-is or modified to suit your own needs.

Line endings

Documents MUST use Unix line endings (LF).
Using Windows (CRLF) line endings will get the document rejected by the platform.

If the document has CSS list-type set to none, some other characters MAY be used to display lists.
For unorganized lists, Middle Dot · (U+00B7 / Alt+0183) MAY be used.


# Header 1
## Header 2

Sections SHOULD begin with a primary header (Header 1), unless the section is a preface in the beginning of a document.
Embedded images MAY be used instead.
The smaller headers (Header 2) have special rules specified in this document.


Format: => [URL] [hyperlink text]
Example: => https://example.com Example text

The last element of a document SHOULD be a primary header "Contributors" or equivalent, where appropriate.
The content in Contributors section SHOULD be a list of identities for which the author has obtained a consent to publish, and may contain additional notes for that specific contributor.
If one or more contributor has not explicitly expressed their consent for their identity to be published as a part of a specific document or a collection of documents from a specific origin, authors SHOULD list "et al." as the final contributor identity of the Contributors list.
If a contributor has explicitly expressed their consent for their identity to be published as a part of a specific document or a collection of documents from a specific origin, authors MUST include an identity of the contributor's choosing in this list.
Contributors list MAY have a prefacing text (e.g. special thanks").
· v7n

Reference is an external resource or a footnote¹ denoted by one or more superscript² digits as UTF-8 byte sequences.³
References MUST be listed in the order they appear in the content of a section and/or document.
References MAY be listed under a secondary header (Header 2) "References", "Footnotes" or equivalent if they are clearly contained within their respective section.
Document-wide references MUST be listed in a "References", "Footnotes" or equivalent section of their own using a primary header.
Reference index MUST begin with 1 with every new section.
Reference header SHOULD be the last secondary header in a section or the last primary header in a document where appropriate.

---