Mettre en surbrillance le code bash/shell dans markdown
Comment mettre en évidence les commandes bash/shell dans les fichiers markdown?
Par exemple pour mettre en surbrillance js
j'écris:
```js
function () { return "This code is highlighted as Javascript!"}
```
Pour mettre en évidence le code HTML, j'utilise ```html
.
Comment mettre en évidence les commandes bash/shell?
5 réponses
Dépend du moteur de rendu markdown et de la saveur markdown. Il n'y a pas de norme pour cela. Si vous voulez dire GitHub aromatisé markdown par exemple, shell
devrait fonctionner correctement. Les alias sont sh
, bash
ou zsh
. Vous pouvez trouver la liste des lexers de syntaxe disponibles ici
Si vous cherchez à mettre en évidence une séquence de commandes de session shell telle qu'elle se présente à l'utilisateur (avec des invites, pas seulement comme contenu d'un fichier de script hypothétique), alors le bon identifiant à utiliser pour le moment est console :
```console
foo@bar:~$ whoami
foo
```
En utilisant le paquet knitr :
```{r, engine='bash', code_block_name} ...
Par exemple:
```{r, engine='bash', count_lines}
wc -l en_US.twitter.txt
```
Vous pouvez également utiliser:
-
engine='sh'
pour shell -
engine='python'
pour python -
engine='perl'
,engine='haskell'
et un tas d'autres C-comme les langues et mêmegawk
,awk
etc.
Par la documentation de GitHub concernant les blocs de code en surbrillance de syntaxe GFM
Nous utilisons Linguist pour effectuer la détection du langage et la coloration syntaxique. Vous pouvez trouver quels mots clés sont valides dans le fichier langages YAML .
Rendu sur GitHub, console
rend les lignes après la console bleues. bash
, sh
, ou shell
ne semblent pas "mettre en évidence" beaucoup ...et vous pouvez utiliser posh
pour PowerShell ou CMD.
Je trouve une bonne description à https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code
Les blocs de Code font partie de la spécification Markdown, mais la coloration syntaxique n'est pas.
Cependant, de nombreux moteurs de rendu-comme Github et Markdown ici-prennent en charge la coloration syntaxique. Les langues prises en charge et la manière dont ces noms de langues doivent être écrits varient d'un moteur de rendu à l'autre. Markdown ici prend en charge la mise en évidence pour des dizaines de langues (et pas vraiment-langages, comme les diffs et les en-têtes HTTP); pour voir la liste complète, et comment écrire les noms de langue, voir le point culminant .js page de démonstration.
Bien que je n'ai trouvé aucun document officiel git hub sur l'utilisation de highlight.js
, j'ai testé beaucoup de langues et semblait fonctionner
Pour voir la liste des langues que j'ai utilisé https://highlightjs.readthedocs.io/en/latest/css-classes-reference.html#language-names-and-aliases
Certains shell échantillons:
Shell: console, shell
Bash: bash, sh, zsh
Powershell: powershell, ps
Dos: dos, bat, cmd
Exemple:
```bat
cd \
copy a b
ping 192.168.0.1
```