diff --git a/app/views/pages/_editor_guide_text.html.erb b/app/views/pages/_editor_guide_text.html.erb index 23d7ca9a3..31b75a9aa 100644 --- a/app/views/pages/_editor_guide_text.html.erb +++ b/app/views/pages/_editor_guide_text.html.erb @@ -6,26 +6,29 @@ <% if version == "1" %> <%= render "pages/v1_editor_guide_preamble" %> <% else %> -
Use markdown to write and format dev.to posts. Use liquid tags to make add rich content such as tweets and videos. More below. ❤️
+Use markdown to write and format dev.to posts. Use + liquid tags to make add rich content such as tweets and videos. More below. ❤️
<% end %>Below are some examples of commonly used markdown syntax. If you want to dive deeper, check out this cheat sheet.
+Below are some examples of commonly used markdown syntax. If you want to dive deeper, check out + this cheat sheet. +
Italics: *asterisks* or _underscores_
Bold: **double asterisks** or __double underscores__
Italics: *asterisks* or _underscores_
Bold: **double asterisks** or __double underscores__
I'm an inline link: [I'm an inline link](put-link-here)
-
-
-  --
figcaption tag!
+ +  ++
figcaption tag!Add a header to your post with this syntax:
@@ -37,7 +40,9 @@We support native Liquid tags in our editor, but have created our own custom tags listed below:
+We support native + Liquid tags in our editor, but have created our own custom tags listed below: +
All you need is the full link of the article:
@@ -54,7 +59,9 @@{% tag git %}
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:
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 %}
{% podcast https://dev.to/basecspodcast/s2e2--queues-irl %}
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.
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 %}
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.
+There are several + optional attributes you can use in your tag, just add them after the id, separated by spaces. +
app{% glitch earthy-course file=script.js %}
All you need is the GitHub username and repo:
@@ -131,11 +142,12 @@{% codepen https://codepen.io/twhite96/pen/XKqrJX %}
default-tab{% codepen https://codepen.io/twhite96/pen/XKqrJX default-tab=js,result %}
- default-tab{% codepen https://codepen.io/twhite96/pen/XKqrJX default-tab=js,result %}
+ Put executable code within a runkit liquid block, as follows:
@@ -146,14 +158,17 @@{% stackblitz ball-demo %}
Default view{% stackblitz ball-demo view=preview %}
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.
+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{% codesandbox ppxnl191zx module=/path/to/module %}
All you need is the full JSFiddle link, ending in the fiddle ID code, as follows:
{% jsfiddle https://jsfiddle.net/link2twenty/v2kx9jcd %}
Custom tabs{% jsfiddle https://jsfiddle.net/webdevem/Q8KVC result,html,css %}
- Custom tabs{% jsfiddle https://jsfiddle.net/webdevem/Q8KVC result,html,css %}
+ All you need is the URL after the domain name:
@@ -213,7 +230,8 @@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:
One specific edge case is with using the raw tag. To properly escape it, use this format:
+
`{% raw %}{{site.SOMETHING }} {% ``endraw`` %}`
Our RSS reader converts some tags from the RSS items to tags for the Jekyll front matter:
<title>: title<category>: tags, comma separated. Since only 4 tags can be used in a post on dev.to, only the first four tags will be used from the RSS item.<link>: canonical_url<category>:
+ tags, comma separated. Since only 4 tags can be used in a post on dev.to, only the first four tags will be used from the RSS item.
+ <link>:
+ canonical_urlThe article content is prioritized in this order: <content>, <summary>, or <description>. The HTML will be converted to Markdown as the body of the DEV post.
The article content is prioritized in this order: <content>,
+ <summary>, or
+ <description>. The HTML will be converted to Markdown as the body of the DEV post.
If you're using a Medium RSS feed, Tweet links, YouTube, and Gist iframes are converted to Liquid tags.
Custom variables set for each post, located between the triple-dashed lines in your editor. Here is a list of possibilities:
-Custom variables set for each post, located between the triple-dashed lines in your editor. Here is a list of possibilities:
+- Where programmers share ideas and help each other grow. It is an online community for sharing and discovering great ideas, having debates, and making friends. Anyone can share articles, questions, discussions, etc. as long as they have the rights to the words they are sharing. Cross-posting from your own blog is welcome. -
-+ Where programmers share ideas and help each other grow. It is an online community for sharing and discovering great ideas, having debates, and making friends. Anyone can share articles, questions, discussions, etc. as long as they have the rights to the words they are sharing. Cross-posting from your own blog is welcome. +
+- The platform was created in 2016. The Twitter account, @ThePracticalDev was around before then. We are based out of New York City. -
+ ++ The platform was created in 2016. The Twitter account, + @ThePracticalDev was around before then. We are based out of New York City. +