Published on

πŸ“ ПолноС руководство ΠΏΠΎ Markdown

Authors

πŸ” Π’Π²Π΅Π΄Π΅Π½ΠΈΠ΅

ΠŸΠ°Ρ€ΡΠΈΠ½Π³ Markdown ΠΈ MDX поддСрТиваСтся Ρ‡Π΅Ρ€Π΅Π· unified, Π° Ρ‚Π°ΠΊΠΆΠ΅ Π΄Ρ€ΡƒΠ³ΠΈΠ΅ ΠΏΠ°ΠΊΠ΅Ρ‚Ρ‹ remark ΠΈ rehype. next-mdx-remote позволяСт Π½Π°ΠΌ ΠΏΠ°Ρ€ΡΠΈΡ‚ΡŒ Ρ„Π°ΠΉΠ»Ρ‹ .mdx ΠΈ .md Π±ΠΎΠ»Π΅Π΅ Π³ΠΈΠ±ΠΊΠΎ Π±Π΅Π· нСобходимости ΠΈΠ·ΠΌΠ΅Π½ΡΡ‚ΡŒ webpack.

Π˜ΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠ΅Ρ‚ΡΡ GitHub flavored markdown. mdx-prism прСдоставляСт возмоТности подсвСтки синтаксиса для Π±Π»ΠΎΠΊΠΎΠ² ΠΊΠΎΠ΄Π°. Π’ΠΎΡ‚ дСмонстрация Ρ‚ΠΎΠ³ΠΎ, ΠΊΠ°ΠΊ всё это выглядит.

Π‘Π»Π΅Π΄ΡƒΡŽΡ‰Π°Ρ ΡˆΠΏΠ°Ρ€Π³Π°Π»ΠΊΠ° ΠΏΠΎ Markdown Π°Π΄Π°ΠΏΡ‚ΠΈΡ€ΠΎΠ²Π°Π½Π° ΠΈΠ·: Mastering Markdown

❓ Π§Ρ‚ΠΎ Ρ‚Π°ΠΊΠΎΠ΅ Markdown?

Markdown β€” это способ стилизации тСкста Π² ΠΈΠ½Ρ‚Π΅Ρ€Π½Π΅Ρ‚Π΅. Π’Ρ‹ управляСтС ΠΎΡ‚ΠΎΠ±Ρ€Π°ΠΆΠ΅Π½ΠΈΠ΅ΠΌ Π΄ΠΎΠΊΡƒΠΌΠ΅Π½Ρ‚Π°: Ρ„ΠΎΡ€ΠΌΠ°Ρ‚ΠΈΡ€ΠΎΠ²Π°Π½ΠΈΠ΅ тСкста ΠΊΠ°ΠΊ ΠΆΠΈΡ€Π½ΠΎΠ³ΠΎ ΠΈΠ»ΠΈ курсива, Π΄ΠΎΠ±Π°Π²Π»Π΅Π½ΠΈΠ΅ ΠΈΠ·ΠΎΠ±Ρ€Π°ΠΆΠ΅Π½ΠΈΠΉ ΠΈ созданиС списков β€” это лишь нСсколько Π²Π΅Ρ‰Π΅ΠΉ, ΠΊΠΎΡ‚ΠΎΡ€Ρ‹Π΅ ΠΌΠΎΠΆΠ½ΠΎ Π΄Π΅Π»Π°Ρ‚ΡŒ с ΠΏΠΎΠΌΠΎΡ‰ΡŒΡŽ Markdown. Π’ основном, Markdown β€” это ΠΎΠ±Ρ‹Ρ‡Π½Ρ‹ΠΉ тСкст с нСсколькими Π½Π΅Π°Π»Ρ„Π°Π²ΠΈΡ‚Π½Ρ‹ΠΌΠΈ символами, Ρ‚Π°ΠΊΠΈΠΌΠΈ ΠΊΠ°ΠΊ # ΠΈΠ»ΠΈ *.

πŸ“š Π‘ΠΏΡ€Π°Π²ΠΎΡ‡Π½ΠΈΠΊ ΠΏΠΎ синтаксису

Π’ΠΎΡ‚ ΠΎΠ±Π·ΠΎΡ€ синтаксиса Markdown, ΠΊΠΎΡ‚ΠΎΡ€Ρ‹ΠΉ Π²Ρ‹ ΠΌΠΎΠΆΠ΅Ρ‚Π΅ ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ Π³Π΄Π΅ ΡƒΠ³ΠΎΠ΄Π½ΠΎ Π½Π° GitHub.com ΠΈΠ»ΠΈ Π² своих тСкстовых Ρ„Π°ΠΉΠ»Π°Ρ….

πŸ“Œ Π—Π°Π³ΠΎΠ»ΠΎΠ²ΠΊΠΈ

# Π­Ρ‚ΠΎ Ρ‚Π΅Π³ h1

## Π­Ρ‚ΠΎ Ρ‚Π΅Π³ h2

#### Π­Ρ‚ΠΎ Ρ‚Π΅Π³ h4

Π­Ρ‚ΠΎ Ρ‚Π΅Π³ h1

Π­Ρ‚ΠΎ Ρ‚Π΅Π³ h2

Π­Ρ‚ΠΎ Ρ‚Π΅Π³ h4

✨ Π’Ρ‹Π΄Π΅Π»Π΅Π½ΠΈΠ΅ тСкста

_Π­Ρ‚ΠΎΡ‚ тСкст Π±ΡƒΠ΄Π΅Ρ‚ курсивом_

**Π­Ρ‚ΠΎΡ‚ тСкст Π±ΡƒΠ΄Π΅Ρ‚ ΠΆΠΈΡ€Π½Ρ‹ΠΌ**

_Π’Ρ‹ **ΠΌΠΎΠΆΠ΅Ρ‚Π΅** ΠΊΠΎΠΌΠ±ΠΈΠ½ΠΈΡ€ΠΎΠ²Π°Ρ‚ΡŒ ΠΈΡ…_

Π­Ρ‚ΠΎΡ‚ тСкст Π±ΡƒΠ΄Π΅Ρ‚ курсивом

Π­Ρ‚ΠΎΡ‚ тСкст Π±ΡƒΠ΄Π΅Ρ‚ ΠΆΠΈΡ€Π½Ρ‹ΠΌ

Π’Ρ‹ ΠΌΠΎΠΆΠ΅Ρ‚Π΅ ΠΊΠΎΠΌΠ±ΠΈΠ½ΠΈΡ€ΠΎΠ²Π°Ρ‚ΡŒ ΠΈΡ…

πŸ“‹ Бписки

НСупорядочСнный список

- Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 1
- Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 2
- Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 2a
- Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 2b
  • Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 1
  • Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 2
  • Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 2a
  • Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 2b

УпорядочСнный список

1. Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 1
1. Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 2
1. Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 3
1. Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 3a
1. Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 3b
  1. Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 1
  2. Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 2
  3. Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 3
  4. Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 3a
  5. Π­Π»Π΅ΠΌΠ΅Π½Ρ‚ 3b

πŸ–ΌοΈ Π˜Π·ΠΎΠ±Ρ€Π°ΠΆΠ΅Π½ΠΈΡ

![Π›ΠΎΠ³ΠΎΡ‚ΠΈΠΏ GitHub](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)
Π€ΠΎΡ€ΠΌΠ°Ρ‚: ![ΠΠ»ΡŒΡ‚Π΅Ρ€Π½Π°Ρ‚ΠΈΠ²Π½Ρ‹ΠΉ тСкст](URL)

Π›ΠΎΠ³ΠΎΡ‚ΠΈΠΏ GitHub

πŸ”— Бсылки

http://github.com - автоматичСски!
[GitHub](http://github.com)

http://github.com - автоматичСски! GitHub

πŸ’¬ Π¦ΠΈΡ‚Π°Ρ‚Ρ‹

Как сказал КаньС Уэст:

> ΠœΡ‹ ΠΆΠΈΠ²Ρ‘ΠΌ Π² Π±ΡƒΠ΄ΡƒΡ‰Π΅ΠΌ, поэтому
> настоящСС β€” это нашС ΠΏΡ€ΠΎΡˆΠ»ΠΎΠ΅.

Как сказал КаньС Уэст:

ΠœΡ‹ ΠΆΠΈΠ²Ρ‘ΠΌ Π² Π±ΡƒΠ΄ΡƒΡ‰Π΅ΠΌ, поэтому настоящСС β€” это нашС ΠΏΡ€ΠΎΡˆΠ»ΠΎΠ΅.

</> ВстроСнный ΠΊΠΎΠ΄

Π― Π΄ΡƒΠΌΠ°ΡŽ, Π²Π°ΠΌ слСдуСт ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ
здСсь элСмСнт `<addr>`.

Π― Π΄ΡƒΠΌΠ°ΡŽ, Π²Π°ΠΌ слСдуСт ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ здСсь элСмСнт <addr>.

🌈 ΠŸΠΎΠ΄ΡΠ²Π΅Ρ‚ΠΊΠ° синтаксиса

Π’ΠΎΡ‚ ΠΏΡ€ΠΈΠΌΠ΅Ρ€ Ρ‚ΠΎΠ³ΠΎ, ΠΊΠ°ΠΊ ΠΌΠΎΠΆΠ½ΠΎ ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ подсвСтку синтаксиса с GitHub Flavored Markdown:

```js:fancyAlert.js
function fancyAlert(arg) {
  if (arg) {
    $.facebox({ div: '#foo' })
  }
}
```

И Π²ΠΎΡ‚ ΠΊΠ°ΠΊ это выглядит β€” с красивой подсвСткой ΠΈ стилизованными Π·Π°Π³ΠΎΠ»ΠΎΠ²ΠΊΠ°ΠΌΠΈ ΠΊΠΎΠ΄Π°!

fancyAlert.js
function fancyAlert(arg) {
  if (arg) {
    $.facebox({ div: '#foo' })
  }
}

πŸ“ Бноски

Π’ΠΎΡ‚ простая сноска[^1]. И Π½Π΅ΠΌΠ½ΠΎΠ³ΠΎ тСкста послС Π½Π΅Ρ‘.

[^1]: Моя сноска.

Π’ΠΎΡ‚ простая сноска1. И Π½Π΅ΠΌΠ½ΠΎΠ³ΠΎ тСкста послС Π½Π΅Ρ‘.

βœ… Бписки Π΄Π΅Π»

- [x] ВрСбуСтся синтаксис списка (поддСрТиваСтся любой ΠΌΠ°Ρ€ΠΊΠΈΡ€ΠΎΠ²Π°Π½Π½Ρ‹ΠΉ ΠΈΠ»ΠΈ Π½ΡƒΠΌΠ΅Ρ€ΠΎΠ²Π°Π½Π½Ρ‹ΠΉ список)
- [x] это Π²Ρ‹ΠΏΠΎΠ»Π½Π΅Π½Π½Ρ‹ΠΉ ΠΏΡƒΠ½ΠΊΡ‚
- [ ] это Π½Π΅Π²Ρ‹ΠΏΠΎΠ»Π½Π΅Π½Π½Ρ‹ΠΉ ΠΏΡƒΠ½ΠΊΡ‚
  • ВрСбуСтся синтаксис списка (поддСрТиваСтся любой ΠΌΠ°Ρ€ΠΊΠΈΡ€ΠΎΠ²Π°Π½Π½Ρ‹ΠΉ ΠΈΠ»ΠΈ Π½ΡƒΠΌΠ΅Ρ€ΠΎΠ²Π°Π½Π½Ρ‹ΠΉ список)
  • это Π²Ρ‹ΠΏΠΎΠ»Π½Π΅Π½Π½Ρ‹ΠΉ ΠΏΡƒΠ½ΠΊΡ‚
  • это Π½Π΅Π²Ρ‹ΠΏΠΎΠ»Π½Π΅Π½Π½Ρ‹ΠΉ ΠΏΡƒΠ½ΠΊΡ‚

πŸ“Š Π’Π°Π±Π»ΠΈΡ†Ρ‹

Π’Ρ‹ ΠΌΠΎΠΆΠ΅Ρ‚Π΅ ΡΠΎΠ·Π΄Π°Π²Π°Ρ‚ΡŒ Ρ‚Π°Π±Π»ΠΈΡ†Ρ‹, собирая список слов ΠΈ раздСляя ΠΈΡ… дСфисами - (для ΠΏΠ΅Ρ€Π²ΠΎΠΉ строки), Π° Π·Π°Ρ‚Π΅ΠΌ раздСляя ΠΊΠ°ΠΆΠ΄Ρ‹ΠΉ столбСц Π²Π΅Ρ€Ρ‚ΠΈΠΊΠ°Π»ΡŒΠ½ΠΎΠΉ Ρ‡Π΅Ρ€Ρ‚ΠΎΠΉ |:

| ΠŸΠ΅Ρ€Π²Ρ‹ΠΉ Π·Π°Π³ΠΎΠ»ΠΎΠ²ΠΎΠΊ | Π’Ρ‚ΠΎΡ€ΠΎΠΉ Π·Π°Π³ΠΎΠ»ΠΎΠ²ΠΎΠΊ |
| ---------------- | ---------------- |
| Π‘ΠΎΠ΄Π΅Ρ€ΠΆΠΈΠΌΠΎΠ΅ ячСйки 1 | Π‘ΠΎΠ΄Π΅Ρ€ΠΆΠΈΠΌΠΎΠ΅ ячСйки 2 |
| Π‘ΠΎΠ΄Π΅Ρ€ΠΆΠΈΠΌΠΎΠ΅ Π² ΠΏΠ΅Ρ€Π²ΠΎΠΌ столбцС | Π‘ΠΎΠ΄Π΅Ρ€ΠΆΠΈΠΌΠΎΠ΅ Π²ΠΎ Π²Ρ‚ΠΎΡ€ΠΎΠΌ столбцС |
ΠŸΠ΅Ρ€Π²Ρ‹ΠΉ Π·Π°Π³ΠΎΠ»ΠΎΠ²ΠΎΠΊΠ’Ρ‚ΠΎΡ€ΠΎΠΉ Π·Π°Π³ΠΎΠ»ΠΎΠ²ΠΎΠΊ
Π‘ΠΎΠ΄Π΅Ρ€ΠΆΠΈΠΌΠΎΠ΅ ячСйки 1Π‘ΠΎΠ΄Π΅Ρ€ΠΆΠΈΠΌΠΎΠ΅ ячСйки 2
Π‘ΠΎΠ΄Π΅Ρ€ΠΆΠΈΠΌΠΎΠ΅ Π² ΠΏΠ΅Ρ€Π²ΠΎΠΌ столбцСБодСрТимоС Π²ΠΎ Π²Ρ‚ΠΎΡ€ΠΎΠΌ столбцС

πŸ—‘οΈ Π—Π°Ρ‡Ρ‘Ρ€ΠΊΠ½ΡƒΡ‚Ρ‹ΠΉ тСкст

Π›ΡŽΠ±ΠΎΠ΅ слово, ΠΎΠ±Ρ‘Ρ€Π½ΡƒΡ‚ΠΎΠ΅ Π² Π΄Π²Π΅ Ρ‚ΠΈΠ»ΡŒΠ΄Ρ‹ (Π½Π°ΠΏΡ€ΠΈΠΌΠ΅Ρ€, ~~это~~), Π±ΡƒΠ΄Π΅Ρ‚ ΠΎΡ‚ΠΎΠ±Ρ€Π°ΠΆΠ°Ρ‚ΡŒΡΡ Π·Π°Ρ‡Ρ‘Ρ€ΠΊΠ½ΡƒΡ‚Ρ‹ΠΌ.

Footnotes

  1. Моя сноска. ↩