Style Guide

Last updated 12 days ago

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.

  • Headers should be done with two #'s, e.g. ## 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 should be in code blocks with the cpp style applied for 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 as inline images..

..or as embedded images from a cloud storage provider that provides publicly accessible links:

  • Avoid run on paragraphs and sentences.

  • Clear and correct punctuation.