Comment mettre en évidence les commandes bash/Shell dans les fichiers de démarques?
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 pouvons-nous mettre en évidence les commandes bash/Shell?
Dépend du moteur de rendu de démarque et de son style. Il n'y a pas de standard pour cela. Si vous parlez de gullub, par exemple, Shell
devrait bien fonctionner. Les alias sont sh
, bash
ou zsh
. Vous pouvez trouver la liste des lexers de syntaxe disponibles ici
Si vous souhaitez mettre en évidence une séquence de commandes de session Shell telle qu'elle apparaît à l'utilisateur (avec des invites, pas uniquement le contenu d'un fichier de script hypothétique), l'identificateur correct à 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 aussi utiliser:
engine='sh'
pour Shell engine='python'
pour python engine='Perl'
, engine='haskell'
et un tas d'autres langages de type C et même gawk
, awk
etc.D'après la documentation de GitHub concernant la syntaxe GFM en surbrillance des blocs de code
Nous utilisons Linguist pour effectuer la détection de la langue et la coloration syntaxique. Vous pouvez trouver quels mots-clés sont valides dans le fichier de langues YAML .
Rendu sur GitHub, console
rend les lignes après la console en bleu. bash
, sh
ou Shell
ne semblent pas beaucoup "surligner" ... et vous pouvez utiliser posh
pour PowerShell ou CMD.
Je trouve une bonne description sur https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code
Les blocs Code font partie de la spécification Markdown, mais la coloration syntaxique n'est pas.
Cependant, de nombreux moteurs de rendu, tels que Github et Markdown Here, prennent en charge la coloration syntaxique. Les langues prises en charge et la manière dont ces noms doivent être écrits varient d'un moteur de rendu à l'autre. Markdown Here prend en charge la surbrillance pour des dizaines de langues (et pas vraiment, comme les en-têtes diff et HTTP); pour voir la liste complète et savoir comment écrire les noms de langue, voir la page de démonstration highlight.js .
Bien que je n’aie trouvé aucun document officiel de git hub concernant l’utilisation de highlight.js
, j’ai testé de nombreuses langues et semblais fonctionner.
Pour voir la liste des langues que j'ai utilisées https://highlightjs.readthedocs.io/en/latest/css-classes-reference.html#language-names-and-aliases
Quelques échantillons de Shell:
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
```
Bitbucket utilise CodeMirror pour la coloration syntaxique. Pour bash ou Shell, vous pouvez utiliser sh
, bash
ou zsh
. Pour plus d'informations, voir Configuration de la coloration syntaxique pour les extensions de fichier et Modes de langage en miroir de code .