Как нам говорит википедия: "Markdown (произносится маркда́ун) — облегченный язык разметки, созданный с целью написания наиболее читаемого и удобного для правки текста, но пригодного для преобразования в языки для продвинутых публикаций (HTML, Rich Text и других)."
А если просто, то это просто язык разметки (набор соглашений и правил)
Ниже приведу примеры использования этого языка, которые, на мой взгляд, перекрывают 99% задач, при оформлении проекта в Jupyter notebook.
Начну с самого базового. Если упростить, то объясню так: по умолчанию ячейки в Jupyter работают только с кодом python. Чтобы создать ячейку с типом markdown можно ее выделить и нажать кнопку М (латинская). Если вы все сделали правильно, то слева от ячейки пропадет поле для порядкового номера выполнения ячейки (скрин ниже)
Работа с текстом
Выделение текста:
- **выделение текста жирным** (эквивалент в HTML <strong>Жирный текст</strong>)
- *выделение текста курсивом* (эквивалент в HTML <em>Это курсив</em>)
- ***Выделение текста жирным курсивом*** (эквивалент в HTML <strong><em>Выделение текста жирным курсивом</em></strong>)
- ~перечеркнутый текст~ (эквивалент в HTML <del>перечеркнутый текст</del>)
ниже приведены примеры в Jupyter notebook
Оформление заголовков
C заголовками все очень просто. Для этого нужно перед заголовком поставить символ решетки.
Такое оформление в markdown является подобием синтаксиса HTML (<h1>Заголовок 1</h1>, ..., <h6>Заголовок 6</h6>)
Если вам нужно экранировать какой-либо символ в тексте, используйте обратный слэш. Пример ниже:
Оформление списков
Можно создавать как пронумерованные списки, так и непронумерованные. Также списки могут быть многоуровневыми. Примеры ниже:
Нумерованные списки:
Нумерованные списки:
Оформление параграфов
Для выделения параграфа используется две или более пустые строки
Цитаты
Для оформления цитат нужно использовать символ ">"
Оформление вложенных блоков
Разделение с помощью линий
Для разделения можно использовать 3 и более знака ***/___/---
...
Продолжение в статье "Использование markdown с примерами в Jypyter Notebook (часть 2)"