2014-06-19 8 views
12

Ich schreibe einige Dokumentation in markdown und ich möchte dokumentieren, wie Sie eine Textdatei mit einem Bash HEREDOC erstellen. Hier ist der Befehl, den ich dokumentieren mag:Wie entgeht man Backticks im Abschlag?

# cat > /tmp/answers.txt <<EOT 
> value1=blah 
> value2=something else 
> value3=`hostname` 
> value4=onetwothree 
EOT 

In Abschlag verwendet man den `den Text als„Code“zu machen, ich habe versucht, dies zu tun ...

`# cat > /tmp/answers.txt <<EOT` 
`> value1=blah` 
`> value2=something else` 
`> value3=\`hostname\`` 
`> value4=onetwothree` 
`EOT` 

... aber die Ergebnisse in etwas, das wie folgt aussieht ...

# cat > /tmp/answers.txt <<EOT 
> value1=blah 
> value2=something else 
> value3=\ 

Hostname
> value4 = onetwothree
EOT

Antwort

6

Dieser Codeblock unten funktioniert der Trick.

``` 
# cat > /tmp/answers.txt <<EOT 
> value1=blah 
> value2=something else 
> value3=`hostname` 
> value4=onetwothree 
EOT 
``` 

Die drei Graviszeichen bedeutet es, Code-Snippet ist und ein Snippet muss mit drei weiteren Graviszeichen beenden.

Für weitere Hilfe mit Markdown finden Sie diese CheatSheet.

6

Ich glaube, Sie müssen die "Trennzeichen" von einem einzigen zurück Zecke zu einem Doppel ändern ...

d.h .: ``value3=\`hostname\` ``

> value3=\`hostname\`

+1

Danke für die Antwort, aber das hat nicht mein Problem lösen. Ich denke, ich gehe mit '> value3 = $ (hostname)' und gebe in meinen Skripten alte Backticks auf. –

+0

@RedCricket: Ich aktualisierte meine Kommentare mit besserer Formatierung. Nicht sicher, ob Ihnen das hilft, aber Sie können so viele Back-Ticks verwenden, wie Sie zum Starten/Beenden einer Zeile benötigen. Wenn Sie beispielsweise 3 verwenden, werden 1 oder 2 Back-Ticks korrekt gerendert. Ich denke Ihre Lösung wird auch funktionieren –

+0

@RobertEkendahl das hat für mich funktioniert.Ich denke, die allgemeine Lösung des Problems ist, dass wenn Sie Back-Ticks innerhalb des Codeblocks verwenden möchten, Sie es nicht mit einzelnen Back-Ticks eingrenzen können. Sie brauchen doppelt oder dreifach. Vielen Dank! –

15

The original Markdown syntax documentation covers this machen sollte; es sagt, dass Sie mehrere Backticks verwenden, um den Code Ausdruck umklammern, so wie folgt aus:

``here you go - ` this was a backtick`` 

wie dies macht:

here you go - ` this was a backtick

Wenn Sie eine Graviszeichen in normalen aufnehmen möchten Text, nicht in einem Codeblock, ein Backslash-Escape macht den Trick; das zum Beispiel:

Here's a backtick: \`; then, here's another one: \` 

macht wie folgt aus:

hier ein Graviszeichen: `; dann, hier ist ein anderes: `

(ich dies auf commonmark getestet und github und es verhält sich genauso so ist es nicht nur eine Kuriosität SO)

+0

Und eine Idee, wie man eine Reihe von Backticks im Klartext rendern kann? –

+1

@WaltStoneburner Antwort aktualisiert. – Glyph

Verwandte Themen