Adapt Wiki Style Guide

[This Style Guide is a draft. It is a work in progress. Perhaps in the future, some form of style guide may be adopted by the Adapt community.]

It is not the intent of this style guide to address every situation encountered in writing a wiki. The intention is to bring a modicum of stylistic uniformity across wiki pages, making them easier to comprehend and easier for an open source community to write.

Code:

• Code will be styled with a tick, a fenced code block, or syntax highlighting.

Command Lines:

• Code that is presented as command lines will not start with a prompt such as $. Including it complicates using the code via copying and pasting, since the $ must be deleted.
• Command lines will start on their own line.
• Command lines will be styled with a tick, a fenced code block, or syntax highlighting.

Links:

• In general, hyperlinks to external resources will not use Git Flavored Markdown (GFM) such as [GitHub](https://github.com). They will instead use the HTML <a> tag with the attribute target="_blank". The rationale is to avoid having secondary content detract from progress through the wiki page's content. (GFM does not currently support target="_blank". This style rule should be reconsidered if support begins.)