Write markdown using markdown

Question

Я пытался написать код разметки с помощью уценки в github, но это всегда приводит к некоторому странному формату, есть ли какие-либо идеи по этой проблеме?

Например: Я хочу

# header1 # 

но всегда отображаться как реальный заголовок

header1

, и это также происходит с блоком кода, я хочу

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

но Я получил

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

Это настолько смущает. Есть ли хороший способ написать это в уценке?

Answer 1

Вы можете избежать символы, такие как # или _ в Markdown с обратной косой черты. Например:

\ # заголовок 1

Если вы посмотрите на исходный код этого поста, вы на самом деле будете замечать, что я должен был избежать экранирующего символа, так что обратный слеш будет отображать в ответ, но единственная обратная косая черта - это все, что вам нужно, чтобы иметь специальный символ, который будет отображаться буквально.

Вы также можете использовать предварительно отформатированные кодовые блоки, отпечатав свой текст на 4 пробела. Например:

# header 1 

Опять же, если вы посмотрите на исходный код вы будете видеть, что я на самом деле отступом 8 пробелов, так что блок кода показывает 4 символов пробела. Тем не менее, отступы на 4 пробела, как правило, все, что вам нужно, чтобы отобразить источник Markdown, если вы не пытаетесь получить мета-рендеринг.

Answer 2

Еще один совет просто обернуть код уценки в <pre></pre> (что исключает необходимость добавления 4 пробелов в начале каждой строки)

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