Перейти к содержимому

Markdown (*.md) — как писать и отображать.

Markdown (*.md) — как писать и отображать

Синтаксис написания

# Заголовок 1
## Заголовок 2
### Заголовок 3

**жирный текст**
*курсив*
~~зачёркнутый~~

- элемент списка
- другой элемент
  - вложенный

1. нумерованный
2. список

[ссылка](https://example.com)
![картинка](image.png)

`код в строке`

​```javascript
// блок кода
const x = 42;
​```

| Колонка 1 | Колонка 2 |
|-----------|-----------|
| ячейка    | ячейка    |

> цитата

---  (горизонтальная линия)

Отображение в браузере

Браузер не рендерит .md файлы сам по себе — он покажет просто текст. Варианты отображения:

1. VS Code — уже встроено. Нажмите Ctrl+Shift+V для предпросмотра, или Ctrl+K V для предпросмотра сбоку.

2. GitHub / GitLab — автоматически рендерят README.md и любые .md файлы в репозитории.

3. В браузере через JS-библиотеку — если хотите встроить в свой сайт:

<!-- подключить marked.js -->
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>

<div id="content"></div>
<script>
  fetch('README.md')
    .then(r => r.text())
    .then(text => {
      document.getElementById('content').innerHTML = marked.parse(text);
    });
</script>

4. Расширение для браузера — установите расширение «Markdown Viewer» для Chrome/Firefox, и .md файлы будут рендериться при открытии через file://.

5. Конвертация в HTML — через CLI-утилиты:

# через npx (без установки)
npx marked -i README.md -o output.html

# или pandoc
pandoc README.md -o output.html

Что выбрать?

Для вашего случая (просмотр CLAUDE.md) проще всего — VS Code: Ctrl+Shift+V прямо в редакторе.