Skip to content

Codecademy Curriculum Markdown Style Guide

Description/Purpose

Codecademy's Markdown rendering supports Github Flavored Markdown. (Here's a quick reference you can use.)

Code Blocks

Code blocks support syntax highlighting for the following languages:

  • C++: ```cpp
  • C#: ```cs
  • CSS: ```css
  • HTML: ```html
  • Java: ```java
  • JavaScript: ```js
  • PHP: ```php
  • Python: ```py
  • R: ```r
  • Ruby: ```rb
  • Sass: ```scss
  • Shell/Program Output/Unhighlighted: ```
  • SQL: ```sql

Note that code blocks must contain syntactically-valid code snippets for the syntax highlighting to be consistent.

Will render correctly:

function doSomething() {
   // statements go here
}

Will NOT render correctly:

function doSomething() {
   ...
}

Tables

Markdown tables used to be created using the narrative-table-container wrapper. Now it can be created without. For example:

| A | B | Ouput |
| --- | --- | --- |
| 0 | 0 | 0 |
| 0 | 1 | 1 |
| 1 | 0 | 1 |
| 1 | 1 | 1 |

will result in:

A B Ouput
0 0 0
0 1 1
1 0 1
1 1 1

Note that the number of columns with dashes, under the table headers, should be the same as the number of columns.

LaTeX

```tex allows TeX directives to be written into instructional narrative.

x^2 + y^2 = 1

will result in:

LaTex forumula

y = \sqrt{1 - x^2}

will result in:

LaTex forumula

\sum\limits_{n=1}^{\infty} 2^{-n} = 1

will result in:

LaTex forumula

Keyboard Input

Keyboard inputs can be enclosed by the <kbd> tag:

<kbd>control</kbd> + <kbd>c</kbd>

will result in:

control + c.