Write markdown using markdown

Question

I was trying to write some markdown code using markdown in github, but it always leads to some strange format, is there any idea about this issue?

For example: I wanna

# header1 #

but it always display as real header

header1

and it also happens to code block, i wanna

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

but I got

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

that is so confusing. Is there a good way to write it in markdown?

Your content is hilariously messed up... You know, asking for Markdown help on a site that uses Markdown in completely broken Markdown. — Nils Werner
– Nils Werner, Commented Sep 15, 2014 at 6:53

Todd A. Jacobs · Accepted Answer · 2014-09-15 03:14:17Z

3

You can escape characters like # or _ in Markdown with a backslash. For example:

\# header 1

If you look at the source code of this post, you'll actually notice that I had to escape the escape character so that the backslash would display in the answer, but a single backslash is all you need to have a special character rendered literally.

You can also use pre-formatted code blocks by indenting your text 4 spaces. For example:

    # header 1

Again,if you look at the source you'll see I actually indented 8 spaces so that the code block shows 4 space characters. However, indenting by 4 spaces is generally all you need to display your Markdown source, unless you're trying to be very meta with your rendering.

answered Sep 15, 2014 at 3:14

Todd A. Jacobs

85.1k15 gold badges147 silver badges209 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

VonC · Accepted Answer · 2014-09-15 06:46:27Z

2

Another tip is simply to wrap your markdown code in <pre></pre> (that avoids the need to add 4 spaces at the beginning of each line)

# tilte
```` ruby
code
````

answered Sep 15, 2014 at 6:46

VonC

1.4m568 gold badges4.8k silver badges5.7k bronze badges

Comments

Terry Lin · Accepted Answer · 2019-03-25 17:00:45Z

0

You can use backslash to escape Markdown syntax. Just put it in the beginning of the line. Just try Markdown editor online and you will simply see how it works.

answered Mar 25, 2019 at 17:00

Terry Lin

2,60725 silver badges21 bronze badges

Collectives™ on Stack Overflow

Write markdown using markdown

header1

3 Answers 3

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

header1

3 Answers 3

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related