Style Guide

Next Tech supports GitHub Flavored Markdown (GFM) to help improve the readability of the instructions and the retention of information, concepts, and examples from readers. When styling instructions and tests it is important to keep your styling consistent, otherwise excess and erratic styling may cause readers some confusion.

Next Tech uses the following style guide when creating and customizing content (including tests):

  • Filenames should be italic: index.html.

  • References to other contents or courses should be italic: "Exploratory Data Analysis in R covers aspects of building KNN models briefly."

  • Headers should be done with one #: # Introduction.

  • Program input / output text should be in bold if it's inline or in an unstyled code block if it's multi line:

Enter John Smith as input.

Enter the following as input:

Sherlock Holmes
Dr. Watson
  • Inline code should be done with inline code: This is some code

  • Multi line code should be in code blocks with the language specified to add syntax highlighting:

some code
more code
* Values in instructions should be formatted in bold: "Assign the value of **57** to variable `x`".
* New concepts should be in **bold**.
* `iostream` \(and other built-in header files\) should be styled as code and not as a file name.
* Tables should be short and to the point and not overly large which can negatively impact the user's experience.
Column 1 | Column 2 | Column 3
data | data | data
data | data | data
  • If the data set is large, it should be included as either a file or image.

  • Formulas can be added using LaTeX. See here for instructions.

  • Avoid run on paragraphs and sentences.

  • Clear and correct punctuation.

  • Images should have captions. See here for instructions.