Wie markiere ich die bash/Shell-Befehle in Markdown-Dateien?
Um zum Beispiel js
hervorzuheben, schreibe ich:
```js
function () { return "This code is highlighted as Javascript!"}
```
Um HTML-Code hervorzuheben, verwende ich ```html
.
Wie können wir bash/Shell-Befehle hervorheben?
Abhängig von der Markdown-Rendering-Engine und der Markdown-Variante. Dafür gibt es keinen Standard. Wenn Sie beispielsweise "Github Flavoured Markdown" meinen, könnte Shell
gut funktionieren. Aliase sind sh
, bash
oder zsh
. Die Liste der verfügbaren Syntax-Lexer finden Sie hier
Wenn Sie eine Shell-Sitzungsbefehlssequenz hervorheben möchten, wie sie auf den Benutzer gerichtet ist (mit Eingabeaufforderungen und nicht nur als Inhalt einer hypothetischen Skriptdatei), dann ist der richtige Bezeichner console:
```console
[email protected]:~$ whoami
foo
```
mit dem knitr package:
```{r, engine='bash', code_block_name} ...
z.B.:
```{r, engine='bash', count_lines}
wc -l en_US.Twitter.txt
```
sie können auch verwenden:
engine='sh'
für Shell engine='python'
für Python engine='Perl'
, engine='haskell'
und einige andere C-ähnliche Sprachen und sogar gawk
, awk
usw.In der Dokumentation von GitHub über die GFM-Syntax hervorgehobene Codeblöcke
Wir verwenden Linguist , um Spracherkennung und Syntaxhervorhebung durchzuführen. Welche Schlüsselwörter gültig sind, erfahren Sie in den Sprachen YAML-Dateien .
Auf GitHub gerendert, macht console
die Zeilen nach der Konsole blau. bash
, sh
oder Shell
scheinen sich nicht zu "hervorheben" ... und Sie können posh
für PowerShell oder CMD verwenden.
Eine gute Beschreibung finde ich unter https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code
Codeblöcke sind Teil der Markdown-Spezifikation, die Hervorhebung der Syntax ist jedoch nicht.
Allerdings unterstützen viele Renderer - wie Github's und Markdown Here - die Syntaxhervorhebung. Welche Sprachen unterstützt werden und wie diese Sprachnamen geschrieben werden sollten, variiert von Renderer zu Renderer. Markdown Here unterstützt die Hervorhebung für Dutzende von Sprachen (und nicht wirklich Sprachen wie diffs und HTTP-Header); Die vollständige Liste und das Schreiben der Sprachnamen finden Sie auf der Demo-Seite highlight.js .
Obwohl ich kein offizielles Git-Hub-Dokument über die Verwendung von highlight.js
finden konnte, habe ich viele Sprachen getestet und schien zu funktionieren
Um eine Liste der Sprachen anzuzeigen, die ich verwendet habe https://highlightjs.readthedocs.io/de/latest/css-classes-reference.html#language-names-and-aliases
Einige Shell-Beispiele:
Shell: console, Shell
Bash: bash, sh, zsh
Powershell: powershell, ps
Dos: dos, bat, cmd
Beispiel:
```bat
cd \
copy a b
ping 192.168.0.1
```
Bitbucket verwendet CodeMirror zur Syntaxhervorhebung. Für Bash oder Shell können Sie sh
, bash
oder zsh
verwenden. Weitere Informationen finden Sie unter Syntax-Hervorhebung für Dateierweiterungen konfigurieren und Codespiegelsprachmodi .