Quick-wiki: Style Guide

Quick-wiki: Style Guide

Faced some confusion about styling so wrote a good practices style guide. Much inspiration was taken from the University of Oxford style guide as well as my early day posts.

When in doubt, consult the style guide :D

Table of Content

Headings

Second level (##) heading for ToC or other introductions. Other headings will have third level (###).

Another level can be done with fourth level (####) heading though it essentially is a word which is bold.

Table of Content

For sequential steps use numbers in bullets (ordered list), dash for others (unordered list).

Full stops in bullets only for long sentence.

Comments

Comments can be added to markdown file which won’t be displayed on the page. Format:

<!-- ...comments       -->

Code

Code blocks should be done like this (no space in end backticks):

 ```<lang-code>
 // ... code block
 ` ``

Supported language codes. Highlight specific line and add line numberings format1:

 ```lang-code {linenos=table,hl_lines=[8, "11-13"],linenostart=199}
// ... code
//
 ` ``

Citation

Format for books, website or author citation:

> add the citation text here.
multi-lines can also be done.

> — <cite>Source[^1]</cite>

[^1]: ["title"](link). _Source_

Use ZoteroBib for generating citations reference information. Remove access date.

Images and credits

For images, add alt text:

![Alt text for screen readers](URL)

Format for credits:

<i>
         <div style="text-align: center">
	 <a href="image_source">image_caption</a> by
	 <a href="creater_link">creator_name</a> under
         <a href="license_link"> license_name </a> </div>
</i>

Articles on attribution best practices by Creative Commons and New Media Rights.

Abbreviations

No space or full stops after it.

Cultural creations, websites and emails

Italics and capitalize for books/album/films/website names.

If a chapter/song/article/titles from a large creation is called, single quotes without italics is used.

Emails - mail@example.com

Numbers, time and dates

Spell numbers upto ten, figures for numbers above ten.

Use figures and symbols for percentages, measurements and currency.

Miscellaneous

Notes and side notes should be italics.

Full stops outside brackets with an exception where the sentence starts and end inside brackets.

Menu options to be followed should be in format:

Application -> Install -> Communication

Checklist and multilevel checklist can be done with following syntax:

- [ ] First
- [X] Second
    - [X] Sub-second
- [ ] Third

  1. Highlight options ↩︎