Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 3.5 KB

creating-and-highlighting-code-blocks.md

File metadata and controls

78 lines (56 loc) · 3.5 KB
Raw
title intro product redirect_from versions shortTitle
Creating and highlighting code blocks
Share samples of code with fenced code blocks and enabling syntax highlighting.
{% data reusables.gated-features.markdown-ui %}
/articles/creating-and-highlighting-code-blocks
/github/writing-on-github/creating-and-highlighting-code-blocks
/github/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks
fpt ghes ghec
*
*
*
Create code blocks

Fenced code blocks

You can create fenced code blocks by placing triple backticks ``` before and after the code block. We recommend placing a blank line before and after code blocks to make the raw formatting easier to read.

```
function test() {
  console.log("notice the blank line before this function?");
}
```

Screenshot of rendered {% data variables.product.prodname_dotcom %} Markdown showing how triple backticks render code blocks in raw formatting. The block begins with "function test() {."

Tip

To preserve your formatting within a list, make sure to indent non-fenced code blocks by eight spaces.

To display triple backticks in a fenced code block, wrap them inside quadruple backticks.

````
```
Look! You can see my backticks.
```
````

Screenshot of rendered {% data variables.product.prodname_dotcom %} Markdown showing how quadruple backticks cause triple backticks surrounding a code block to remain visible. The block reads, "Look! You can see my backticks."

{% data reusables.user-settings.enabling-fixed-width-fonts %}

Syntax highlighting

You can add an optional language identifier to enable syntax highlighting in your fenced code block.

Syntax highlighting changes the color and style of source code to make it easier to read.

For example, to syntax highlight Ruby code:

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

This will display the code block with syntax highlighting:

Screenshot of three lines of Ruby code as displayed on {% data variables.product.prodname_dotcom %}. Elements of the code display in purple, blue, and red type for scannability.

We use Linguist to perform language detection and to select third-party grammars for syntax highlighting. You can find out which keywords are valid in the languages YAML file.

Creating diagrams

You can also use code blocks to create diagrams in Markdown. GitHub supports Mermaid, GeoJSON, TopoJSON, and ASCII STL syntax. For more information, see AUTOTITLE.

Further reading