Editor Guide 🤓

Things to Know

  • We use a markdown editor that uses Jekyll front matter.
  • Most of the time, you can write inline HTML directly into your posts.
  • We support native Liquid tags and created some fun custom ones, too! Trying embedding a Tweet or GitHub issue in your post.
  • Links to unpublished posts are shareable for feedback/review.
  • When you're ready to publish, set the published variable to true.

We have two editor versions. If you'd prefer to edit title and tags etc. as separate fields, switch to the V2 editor in /settings/misc. Otherwise, continue:

Front Matter

Custom variables set for each post, located between the triple-dashed lines in your editor. Here is a list of possibilities:

  • title: the title of your article
  • published: boolean that determines whether or not your article is published
  • description: description area in Twitter cards and open graph cards
  • tags: max of four tags, needs to be comma-separated
  • canonical_url: link for the canonical version of the content
  • cover_image: cover image for post, accepts a URL.
    The best size is 1000 x 420.
  • series: post series name.

✍ Markdown Basics

Below are some examples of commonly used markdown syntax. If you want to dive deeper, check out this cheat sheet.

Bold & Italic

Italics: *asterisks* or _underscores_

Bold: **double asterisks** or __double underscores__

Links

I'm an inline link: [I'm an inline link](put-link-here)

Anchored links (For things like a Table of Contents)

      ## Table Of Contents
        * [Chapter 1](#chapter-1)
        * [Chapter 2](#chapter-2)

      ### Chapter 1 <a name="chapter-1"></a>

Inline Images

When adding GIFs to posts and comments, please note that there is a limit of 200 megapixels per frame/page. example image, with sloan 

        ![Alt text of image](put-link-to-image-here)
You can even add a caption using the HTML figcaption tag!

Headers

Add a header to your post with this syntax:

      
# One '#' for a h1 header
## Two '#'s for a h2 header
...
###### Six '#'s for a h6 header

One '#' for a h1 header

Two '#'s for a h2 header

Six '#'s for a h6 header

Author Notes/Comments

Add some hidden notes/comments to your article with this syntax:

      <!-- This won't show up in the conent! -->

🌊 Liquid Tags

We support native Liquid tags in our editor, but have created our own custom tags listed below:

dev.to Article/Post Embed

All you need is the full link of the article:

{% link https://dev.to/kazz/boost-your-productivity-using-markdown-1be %}

You can also use the slug like this:

{% link kazz/boost-your-productivity-using-markdown-1be %}

You can also use the alias post instead of link like this:

{% post https://dev.to/kazz/boost-your-productivity-using-markdown-1be %}}

or this:

{% post kazz/boost-your-productivity-using-markdown-1be %}

dev.to User Embed

All you need is the DEV username:

{% user jess %}

dev.to Tag Embed

All you need is the tag name:

{% tag git %}

dev.to Comment Embed

All you need is the ID at the end of a comment URL. To get the comment link, click either the timestamp or the menu button in the top right corner on a comment and then click "Permalink". Here's an example:

{% devcomment 2d1a %}

dev.to Podcast Episode Embed

All you need is the full link of the podcast episode:

{% podcast https://dev.to/basecspodcast/s2e2--queues-irl %}

dev.to Listing Embed

All you need is the full link of the listing:

{% listing https://dev.to/listings/collabs/dev-is-open-source-823 %}

You can also use the category and slug like this:

{% listing collabs/dev-is-open-source-823 %}

Note: Expired listings will raise an error. Make sure the listing is published or recently bumped.

Twitter Embed

Using the Twitter Liquid tag will allow the tweet to pre-render from the server, providing your reader with a better experience. All you need is the tweet id from the url.

{% twitter 834439977220112384 %}

Glitch embed

All you need is the Glitch project slug

{% glitch earthy-course %}

There are several optional attributes you can use in your tag, just add them after the id, separated by spaces.

app
Shows the app preview without the code.
{% glitch earthy-course app %}
code
Shows the code without the app preview.
{% glitch earthy-course code %}
preview-first
Hides the file browser.
{% glitch earthy-course preview-first %}
no-attribution
Hides the file browser.
{% glitch earthy-course no-attribution %}
no-files
Hides the file browser.
{% glitch earthy-course no-files %}
file
Lets you choose which file to display in the code panel. Defaults to index.html.
{% glitch earthy-course file=script.js %}

GitHub Repo Embed

All you need is the GitHub username and repo:

{% github thepracticaldev/dev.to %}
no-readme
You can add a no-readme option to your GitHub tag to hide the readme file from the preview.
{% github thepracticaldev/dev.to no-readme %}

GitHub Issue, Pull request or Comment Embed

All you need is the GitHub issue, PR or comment URL:

{% github https://github.com/thepracticaldev/dev.to/issues/9 %}

GitHub Gist Embed

All you need is the gist link:

{% gist https://gist.github.com/CristinaSolana/1885435 %}
Single File Embed

You can choose to embed a single gist file.
{% gist https://gist.github.com/CristinaSolana/1885435 file=gistfile1.md %}

Specific Version Embed

You can choose to embed a specific version of a gist file. All you need the link and the commit hash for that specific version.
The format is {% gist [gist-link]/[commit-hash] %}
e.g.
{% gist https://gist.github.com/suntong/3a31faf8129d3d7a380122d5a6d48ff6/f77d01e82defbf736ebf4879a812cf9c916a9252 %}

Specific Version File Embed

You can choose to embed a specific version of a gist file. All you need the link, the filename and the commit hash for that specific version .
The format is {% gist [gist-link]/[commit-hash] file=[filename] %}
e.g.
{% gist https://gist.github.com/suntong/3a31faf8129d3d7a380122d5a6d48ff6/f77d01e82defbf736ebf4879a812cf9c916a9252 file=Images.tmpl %}

Video Embed

All you need is the id from the URL.

  • YouTube: {% youtube dQw4w9WgXcQ %}
  • Vimeo: {% vimeo 193110695 %}

Medium Embed

Just enter the full URL of the Medium article you are trying to embed.

{% medium https://medium.com/s/story/boba-science-how-can-i-drink-a-bubble-tea-to-ensure-that-i-dont-finish-the-tea-before-the-bobas-7fc5fd0e442d %}

SlideShare Embed

All you need is the SlideShare key

{% slideshare rdOzN9kr1yK5eE %}

CodePen Embed

All you need is the full CodePen link, ending in the pen ID code, as follows:

{% codepen https://codepen.io/twhite96/pen/XKqrJX %}
default-tab
Add default-tab parameter to your CodePen embed tag. Default to result
{% codepen https://codepen.io/twhite96/pen/XKqrJX default-tab=js,result %}

Kotlin Playground

To create a runnable kotlin snippet, create a Kotlin Snippet at https://play.kotlinlang.org

Go to Share dialog and copy the full link from the Medium tab. Use it as follows:

{% kotlin https://pl.kotl.in/owreUFFUG?theme=darcula&from=3&to=6&readOnly=true %}

RunKit Embed

Put executable code within a runkit liquid block, as follows:

{% runkit
// hidden setup JavaScript code goes in this preamble area
const hiddenVar = 42
%}
// visible, reader-editable JavaScript code goes here
console.log(hiddenVar)
{% endrunkit %}

Stackblitz Embed

All you need is the ID of the Stackblitz:

{% stackblitz ball-demo %}
Default view
You can change the default view, the options are both, preview, editor. Defaults to both
{% stackblitz ball-demo view=preview %}
Default file
You can change the default file you want your embed to point to
{% stackblitz ball-demo file=style.css %}

CodeSandbox Embed

All you need is the ID of the Sandbox:

{% codesandbox ppxnl191zx %}

Of CodeSandbox's many optional attributes, the following are supported by using them in your tag, just add them after the id, separated by spaces.

initialpath
Which url to initially load in address bar.
{% codesandbox ppxnl191zx initialpath=/initial/load/path %}
module
Which module to open by default.
{% codesandbox ppxnl191zx module=/path/to/module %}
runonclick
Delays when code is ran if 1
{% codesandbox ppxnl191zx runonclick=1 %}

JSFiddle Embed

All you need is the full JSFiddle link, ending in the fiddle ID code, as follows:

{% jsfiddle https://jsfiddle.net/link2twenty/v2kx9jcd %}
Custom tabs
You can add a custom tab order to you JSFiddle embed tag. Defaults to js,html,css,result
{% jsfiddle https://jsfiddle.net/webdevem/Q8KVC result,html,css %}

repl.it Embed

All you need is the URL after the domain name:

{% replit @WigWog/PositiveFineOpensource %}

Instagram Embed

All you need is the Instagram post id from the URL.

{% instagram BXgGcAUjM39 %}

Speakerdeck Tag

All you need is the data-id code from the embed link:

      # Given this embed link:
      < script async class="speakerdeck-embed"
            data-id="7e9f8c0fa0c949bd8025457181913fd0"
            data-ratio="1.77777777777778" src="//speakerdeck.com/assets/embed.js">< /script >
    
      {% speakerdeck 7e9f8c0fa0c949bd8025457181913fd0 %}

Soundcloud Embed

Just enter the full URL of the Soundcloud track you are trying to embed.

{% soundcloud https://soundcloud.com/user-261265215/dev-to-review-episode-1 %}

Spotify Embed

Enter the Spotify URI of the Spotify track / playlist / album / artist / podcast episode you are trying to embed. 

      {% spotify spotify:episode:5V4XZWqZQJvbddd31n56mf %}

Blogcast Tag

All you need is the article id code from the embed code:

      {% blogcast 1234 %}

Parler Tag

Enter the full url of the Parler.io audio file you want to embed. 

      {% parler https://www.parler.io/audio/73240183203/d53cff009eac2ab1bc9dd8821a638823c39cbcea.7dd28611-b7fc-4cf8-9977-b6e3aaf644a1.mp3 %}

Stack Exchange / Stack Overflow Tag

You'll need the question or answer's ID code, and the site. When using {% stackoverflow %} as the tag, the site will default to Stack Overflow. For example:
https://stackoverflow.com/questions/24789130/colors-in-irb-rails-console

  • The question ID is: 24789130
{% stackoverflow 24789130 %}

For other Stack Exchange network sites, you'll need to provide the site's name and use {% stackexchange %} as the tag. For example:
https://diy.stackexchange.com/questions/169988/base-for-refrigerator-wine-shelf

  • The question ID is: 169988
  • The site is diy
{% stackexchange 169988 diy %}

For answers, you can get the answer's ID code by from the answer's "Share" link. For example:
https://diy.stackexchange.com/a/170185

  • The answer ID is: 170185
  • The site is diy
{% stackexchange 170185 diy %}

Asciinema Embed

All you need is the Asciinema id:

{% asciinema 239367 %}

Parsing Liquid Tags as a Code Example

To parse Liquid tags as code, simply wrap it with a single backtick or triple backticks.

`{% mytag %}{{ site.SOMETHING }}{% endmytag %}`

One specific edge case is with using the raw tag. To properly escape it, use this format:

`{% raw %}{{site.SOMETHING }} {% ``endraw`` %}`

Common Gotchas

Lists are written just like any other Markdown editor. If you're adding an image in between numbered list, though, be sure to tab the image, otherwise it'll restart the number of the list. Here's an example of what to do: example image of writing lists with images in Markdown

Here's the Markdown cheatsheet again for reference.

Happy posting! 📝