跳转到主要内容

Basic Code Block

Use fenced code blocks by enclosing code in three backticks.

Syntax Highlighting

Put the name of your programming language after the three backticks to get syntax highlighting. We use Prism for syntax highlighting. Test Drive Prism lists all the languages supported.

Names

Add a title after the programming language to set the name of your code example. The text can be anything as long as its all in one line.
Code Block Example
Code Block Example

Line Highlighting

Highlight specific lines in your code blocks by adding a special comment after the language identifier. Use curly braces {} and specify line numbers or ranges separated by commas.
Line Highlighting Example

Expandable

If you have a long code block and [expandable] after your title to make it close and expand.
library.py

Code Groups

Want to display multiple code examples in one code box? Check out the Code Group docs:

Code Group

Read the reference for the Code Group component