Jak napsat blok kódu v Markdownu:ohraničte ho třemi zpětnými apostrofy.
Blok kódu zachová vaše odsazení, použije písmo s pevnou šířkou a s názvem jazyka dostane barevné zvýraznění syntaxe. Tady je syntaxe ohraničení, jazykové značky a co dělat, když kód sám obsahuje zpětné apostrofy.
macOS 14 nebo novější. Čtení je zdarma; úpravy a revize se platí jednou.
Rychlá odpověď
Dejte tři zpětné apostrofy na řádek před kódem a na řádek po něm. Název jazyka napište hned za otevírací apostrofy, tím zapnete zvýraznění syntaxe. Kód uprostřed věty dejte do jednoduchých zpětných apostrofů.
```swift
let greeting = "Hello"
print(greeting)
```
·
Bloky kódu s ohraničením
Ohraničení je řádek alespoň ze tří zpětných apostrofů a blok končí řádkem alespoň stejně dlouhým. Vše mezi nimi se zobrazí tak, jak je napsané: bez tučného písma, bez odkazů, bez spojování řádků.
```
plain text, no colors
indentation is kept
```
Místo toho můžete použít tři vlnovky: ~~~ otevírá a ~~~ zavírá. Oba druhy se nemíchají, takže blok otevřený vlnovkami musí vlnovkami skončit. Blok kódu vznikne i odsazením každého řádku o čtyři mezery, je to starší styl, ale nemůže nést název jazyka, takže ohraničení je lepší volba.
Jazykové značky a zvýraznění syntaxe
Slovo za otevíracím ohraničením je info string. Většina aplikací podle něj vybere zvýrazňovač:
```json
{ "name": "dotmd", "private": true }
```
Běžné názvy, které fungují na GitHubu, v DotMD a ve většině dalších aplikací:
jsnebojavascript,tsnebotypescript,python,swift,go,rustbash,shnebozshpro příkazy shellujson,yaml,html,css,sqlmarkdownnebomdpro zobrazení samotného Markdownu,diffpro změny,textbez barev
Přesný seznam názvů závisí na aplikaci a jejím zvýrazňovači. Název, který aplikace nezná, není chyba: blok se jen zobrazí bez barev. Blok bez jazyka se také zobrazí prostě.
Zpětné apostrofy uvnitř bloku kódu
Pokud kód obsahuje řádek se třemi zpětnými apostrofy, ohraničte blok více. Zavírací ohraničení musí být alespoň tak dlouhé jako otevírací, takže pro zobrazení tří použijte čtyři:
````markdown
```swift
let x = 1
```
````
Tak tato stránka ukazuje příklady Markdownu, které obsahují bloky kódu. Ohraničení vlnovkami funguje stejně: blok otevřený ~~~~ může obsahovat ~~~.
Kód v textu
Pro příkaz nebo název uprostřed věty ho dejte do jednoduchých zpětných apostrofů: `npm install` dá npm install. Chcete-li zobrazit zpětný apostrof, dejte vše mezi dva zpětné apostrofy a přidejte mezeru dovnitř, pokud kód začíná nebo končí zpětným apostrofem:
``a `tick` inside``
Kód v textu také zabrání, aby se znaky jako * a _ četly jako formátování, takže je to správný nástroj pro názvy souborů a proměnných.
Kód v seznamech a citacích
Blok s ohraničením může být uvnitř položky seznamu. Ohraničení odsaďte podle textu položky, aby zůstalo její součástí:
1. Install the tool:
```bash
brew install example
```
2. Run it.
Před ohraničení dejte prázdný řádek a všechny řádky kódu odsaďte stejně. V citaci začněte každý řádek ohraničení znakem >.
Bloky diff
Označte blok jako diff a řádky začínající + nebo - dostanou v aplikacích, které diffy zvýrazňují, zelenou a červenou barvu, včetně GitHubu:
```diff
- let timeout = 30
+ let timeout = 60
```
Je to pohodlný způsob, jak ukázat změnu v dokumentu, README nebo specifikaci bez snímků obrazovky.
Časté chyby
- Kratší zavírací ohraničení než otevírací, takže blok nikdy neskončí a pohltí zbytek stránky.
- Mezery před jazykovou značkou v přísných aplikacích. Pokud se neobjeví barvy, napište
```js, ne``` js. - Míchání zpětných apostrofů a vlnovek v jednom bloku.
- Chybí prázdný řádek před ohraničením po položce seznamu nebo odstavci v některých aplikacích. Přidejte ho.
- Typografické uvozovky. Text vložený z textového procesoru může změnit rovné uvozovky v kódu na typografické. Vkládejte jako prostý text.
Některá ohraničení neslouží k zobrazení kódu. Blok označený mermaid GitHub i DotMD vykreslí jako diagram, pokud je syntaxe platná.
Kontrola barev
Nejrychlejší test jazykové značky je otevřít soubor v čtečce. DotMD barví bloky s ohraničením pomocí highlight.js ve světlém i tmavém vzhledu a po najetí na blok ukáže tlačítko Copy. Čtení je zdarma a zbytek syntaxe najdete na jedné stránce v taháku Markdownu.
Otázky k blokům kódu v Markdownu
Jak udělat blok kódu v Markdownu?
Dejte tři zpětné apostrofy na řádek před kódem a po něm a za otevírací apostrofy případně napište název jazyka. Odsazení čtyřmi mezerami také funguje, ale nemůže nést jazyk.
Jak přidat zvýraznění syntaxe do bloku kódu v Markdownu?
Napište jazyk hned za otevírací ohraničení, například ```python. Barvy vybere aplikace; název, který nezná, se zobrazí jako prostý text.
Jak dát zpětné apostrofy dovnitř bloku kódu v Markdownu?
Otevřete a zavřete blok delším ohraničením, než je cokoli uvnitř, například čtyři zpětné apostrofy kolem kódu, který obsahuje tři. Pro kód v textu s jedním apostrofem použijte dva.
Jaký je rozdíl mezi ``` a ~~~?
Ve vzhledu bloku žádný. Obojí jsou ohraničení, ale blok se musí zavřít stejným znakem, kterým se otevřel.