Jak napisać blok kodu w Markdown:ogrodź go trzema odwróconymi apostrofami.

Bloki kodu w ogrodzeniach

Ogrodzenie to linia z co najmniej trzech odwróconych apostrofów, a blok kończy się linią co najmniej tej samej długości. Wszystko pomiędzy jest pokazane tak, jak wpisano: bez pogrubienia, bez linków, bez sklejania linii.

```
plain text, no colors
  indentation is kept
```

Zamiast tego możesz użyć trzech tyld: ~~~ otwiera i ~~~ zamyka. Obu rodzajów nie można mieszać, więc blok otwarty tyldami musi się zamknąć tyldami. Wcięcie każdej linii o cztery spacje też tworzy blok kodu, to starszy styl, ale nie może nieść nazwy języka, więc lepsze są ogrodzenia.

Znaczniki języka i podświetlanie składni

Słowo po otwierającym ogrodzeniu to ciąg informacyjny. Większość aplikacji używa go do wyboru podświetlacza:

```json
{ "name": "dotmd", "private": true }
```

Popularne nazwy, które działają na GitHubie, w DotMD i w większości innych aplikacji:

• js lub javascript, ts lub typescript, python, swift, go, rust
• bash, sh lub zsh dla poleceń powłoki
• json, yaml, html, css, sql
• markdown lub md do pokazania samego Markdown, diff dla zmian, text dla braku kolorów

Dokładna lista nazw zależy od aplikacji i jej podświetlacza. Nazwa, której aplikacja nie zna, nie jest błędem: blok po prostu pokaże się bez kolorów. Blok bez języka też jest pokazany zwyczajnie.

Pokazywanie odwróconych apostrofów w bloku kodu

Jeśli kod zawiera linię z trzech odwróconych apostrofów, ogrodź go większą ich liczbą. Zamykające ogrodzenie musi być co najmniej tak długie jak otwierające, więc użyj czterech, by pokazać trzy:

````markdown
```swift
let x = 1
```
````

Tak ta strona pokazuje przykłady Markdown zawierające bloki kodu. Ogrodzenia z tyld działają tak samo: blok otwarty ~~~~ może zawierać ~~~.

Kod w linii

Dla polecenia lub nazwy wewnątrz zdania ujmij je w pojedyncze odwrócone apostrofy: `npm install` daje npm install. Aby pokazać odwrócony apostrof, ujmij całość w podwójne odwrócone apostrofy i dodaj spację w środku, jeśli kod zaczyna się lub kończy odwróconym apostrofem:

``a `tick` inside``

Kod w linii chroni też znaki takie jak * i _ przed odczytaniem jako formatowanie, więc jest właściwym narzędziem dla nazw plików i zmiennych.

Kod wewnątrz list i cytatów

Blok w ogrodzeniu może stać wewnątrz pozycji listy. Zrób wcięcie ogrodzenia do poziomu tekstu pozycji, by pozostało jej częścią:

1. Install the tool:

   ```bash
   brew install example
   ```

2. Run it.

Wstaw pustą linię przed ogrodzeniem i wcinaj każdą linię kodu o tyle samo. W cytacie zaczynaj każdą linię ogrodzenia od >.

Bloki diff

Oznacz blok jako diff, a linie zaczynające się od + lub - dostaną zielony i czerwony kolor w aplikacjach podświetlających diffy, w tym na GitHubie:

```diff
- let timeout = 30
+ let timeout = 60
```

To wygodny sposób pokazania zmiany w dokumencie, README lub specyfikacji bez zrzutów ekranu.

Częste błędy

• Krótsze ogrodzenie zamykające niż otwierające, przez co blok nigdy się nie kończy i połyka resztę strony.
• Spacje przed znacznikiem języka w rygorystycznych aplikacjach. Napisz ```js, a nie ``` js, jeśli kolory się nie pojawiają.
• Mieszanie odwróconych apostrofów i tyld w jednym bloku.
• Brak pustej linii przed ogrodzeniem po pozycji listy lub akapicie w niektórych aplikacjach. Dodaj ją.
• Cudzysłowy drukarskie. Tekst wklejony z edytora tekstu może zamienić proste cudzysłowy w kodzie na drukarskie. Wklejaj jako zwykły tekst.

Niektóre ogrodzenia nie służą do pokazywania kodu. Blok oznaczony mermaid jest rysowany jako diagram przez GitHub i przez DotMD, o ile składnia jest poprawna.

Sprawdzanie kolorów

Najszybszy test znacznika języka to otwarcie pliku w czytniku. DotMD koloruje bloki w ogrodzeniach za pomocą highlight.js w jasnym i ciemnym motywie i pokazuje przycisk Copy po najechaniu na blok. Czytanie jest bezpłatne, a ściągawka Markdown ma resztę składni na jednej stronie.

Pytania o bloki kodu w Markdown

Więcej pytań