How to Format Code on Medium

Code formatting on Medium is easy. There are three main ways you can use to format code on Medium:

  1. Inline code for small inline expressions.
  2. Code blocks for larger chunks of code without syntax highlighting.
  3. Github gists for larger chunks of code with syntax highlighting.

How to Write Inline Code

To format code inside a paragraph inline like this: <h1>Hello</h1>, simply highlight the code and press the backtick (`) key.

Here is an illustration:

Notice how inline code cannot be used in headings, quotes, or image captions.

How to Create a Bigger Code Block

If inline code is not enough for your purposes, you can also create a bigger block of code:

while(1 < 2) {
print("Hello, world!")
}

To create a block of code, press one of these key combinations depending on your system:

  • Windows: ctrl+alt+6
  • Mac: command+option+6
  • Linux: ctrl+alt+6

OR type three backticks (“`) in a new line to start a new code block and start typing code.

Tip: If you’re copy-pasting code from an editor to Medium, you may lose code formatting. To fix this, use the Paste and Match Style property by right-clicking the code block when pasting:

Github Gists

This is a common way to add chunks of code to your story.

Embedding your code as a Github Gist preserves the code style e.g. syntax highlighting, indentations, etc:

This is an example.js file embedded to Medium as a Github Gist

Furthermore, if you need to make changes to the code in the gist, the changes will automatically be reflected in the article.

Also, some publications accept programming articles only if Github Gists are used when embedding code.

How to create a Github Gist:

  1. Go to https://gist.github.com/
  2. Give the gist a description, write the code, and remember to use the proper file extension. e.g. with javascript, name your gist like example.js
  3. When you’re ready, publish the gist by creating a public gist.
How to create a Github gist

4. Copy the URL of the published gist and embed it into Medium:

How to format code on Medium — Embedd gists

Conclusion

Today you learned how to format code on Medium in three common ways:

  1. Inline code.
  2. Code blocks
  3. Github gists.

I hope you find these code formatting tips useful.

Further Reading

How to Write on Medium in 2022

How to Get 100 Followers on Medium

Leave a Comment

Your email address will not be published.