| Версия | Что нового |
|---|---|
| 0.1 | Первый релиз |
(Это руководство тоже написано на Markdown! Откройте исходный код, чтобы узнать как это сделано!)
Markdown -- это название одного из самых популярных сегодня облегченных языков разметки. Одна из главных целей при разработке этого языка -- это сделать так, чтобы исходный код был удобен для восприятия в необработанном виде для человека, при этом позволяя делать машинное преобразование в другие форматы документа.
Благодаря тому, насколько удобно писать исходный код в этом языке, он нашел применение в многих онлайн-платформах: например, GitHub, StackOverflow и Discord используют Markdown для отображения текста, введенного пользователем.
Для демонстрации, вот простая страница на HTML -- языке разметки, который используется для сайтов в интернете:
<html>
<head>
<title>Привет, мир!</title>
</head>
<body>
<h1>Привет, мир!</h1>
<p>Это <i>простой</i> пример форматирования документов.</p>
<p>В нем есть <b>два абзаца</b> и сейчас вы читаете второй абзац. Здесь также есть <a href="https://example.com">одна ссылка на веб-страницу</a>.</p>
</body>
</html>Из этого можно прочитать текстовое содержимое страницы, но для этого нужно пропускать глазами много визуального шума. Это потому, что этот язык сделан, чтобы его было легко читать компьютеру. Markdown, напротив, создавался с целью быть удобным для человека, и такая же страница на Markdown выглядит вот так:
# Привет, мир!
Это _простой_ пример форматирования документов.
В нем есть **два абзаца** и сейчас вы читаете второй из них.
Здесь также есть [одна ссылка на веб-страницу](https://example.com).Благодаря коротким и сравнительно простым обозначениям форматирования, код на Markdown имеет гораздо большую читаемость, чем многие другие языки. Это делает его удобным для авторства документов, чтобы потом с помощью программы преобразовать его в другой формат.
Кстати говоря:
Для того, чтобы писать документы на Markdown, можно использовать любой текстовый редактор, и чаще всего удобно, чтобы в этой программе была подсветка синтаксиса Markdown. Большинство редакторов кода имеют такую поддержку -- в том числе такие популярные варианты, как Notepad++, Sublime Text, Atom и Visual Studio Code.
Для того, чтобы увидеть, как будет выглядеть ваш код, можно использовать редактор,
который поддерживает встроенный форматирование Markdown. В вышеупомянутых
редакторах есть дополнения, которые позволяют посмотреть отрендеренный текст.
Помимо них также есть онлайн-редакторы, которые делают то же самое --
например, первый результат поиска markdown online editor выдал
этот онлайн-редактор, и
существует много других по вкусу.
(Здесь и далее я буду использовать слово рендерить и отрендеренный.
Отрендеренный текст -- это текст с примененным форматированием, вроде курсивных
шрифтов, выделенных заголовков и т.д., а исходный код -- это тот текст, который
вы пишете в текстовом редакторе. Например, эта строка:
*This* is ~~some~~ **example** `text`.является исходным кодом, а эта строка:
This is some example text.
является отрендеренным представлением этого исходного кода.)
После того, как вы написали документ на Markdown, вам нужно конвертировать его в какой-то другой формат. Самая универсальная программа для конвертации между форматами -- Pandoc. Именно эта программа используется в РУДН на предмете Операционные системы. TODO: написать, как конвертировать (в т.ч. на Windows).
После того, как у вас есть программы, можно начать писать свой текст.
В Markdown абзацы разделяются двумя переводами строки, или одной пустой строкой. Один абзац можно написать на одной или на нескольких строках исходного кода. Существуют разные стили написания абзацев в исходном коде, среди них:
- один абзац на одной строке
- разбиение строки по ширине экрана
- каждое предложение на новой строке
Этот документ в основном придерживается второго стиля: строки обрываются по
границе в 80 символов.
Конкретно в этой части кода, для демонстрации, я использую третий стиль.
Например, я напишу короткое предложение.
После него я переведу строку и напишу следующее предложение.
Плюсом этого стиля являются более компактные результаты diff:
утилиты, которая показывает строки, различающиеся между файлами.
Когда каждое предложение на одной строке, эта утилита показывает только то,
что на самом деле важно увидеть.
Это первый абзац.
Он состоит из нескольких предложений.
Предыдущие были на разных строках. На этой строке же несколько предложений. Они все являются частью первого абзаца. Даже если
прерывать
строку
на
отдельных
словах,
это все равно первый абзац.
На второй абзац мы переходим только сейчас, после пустой строки.Можно обозначать выделение с помощью курсивного, жирного, или зачеркнутого текста:
| Стиль | Синтаксис | Пример | Отображение |
|---|---|---|---|
| Жирный | ** ** или __ __ |
**Это жирный текст** |
Это жирный текст |
| Курсив | * * или _ _ |
*Это курсивный текст* |
Это курсивный текст |
| Зачеркнутый | ~~ ~~ |
~~Это зачеркнутый текст~~ |
|
| Жирный и курсив внутри | ** ** и _ _ |
**Этот текст _чрезвычайно_ важен** |
Этот текст чрезвычайно важен |
| Жирный и курсив вместе | *** *** |
***Весь этот текст очень важен*** |
Весь этот текст очень важен |
Можно цитировать текст с помощью символа > в начале каждой строки:
Этот абзац -- не цитата.
> Это цитата первого уровня,
> состоящая из нескольких строк.
>
> В ней также два абзаца и *форматирование*.
>
>> Это цитата внутри цитаты,
>> также состоящая из нескольких строк.
>>
>> Многоуровневые цитаты не всегда поддерживаются правильно,
>> и их использование не рекомендуется.Этот абзац -- не цитата.
Это цитата первого уровня, состоящая из нескольких строк.
В ней также два абзаца и форматирование.
Это цитата внутри цитаты, также состоящая из нескольких строк.
Многоуровневые цитаты не всегда поддерживаются правильно, и их использование не рекомендуется.
Чтобы включить отрвыок кода внутрь строчки, нужно окружить его символами обратных кавычек `:
Для создания файлов используется команда `touch`, а для удаления - `rm`.Для создания файлов используется команда
touch, а для удаления -rm.
Чтобы вставить целый блок кода, нужно окружить его строками, содержащими три обратных кавычки подряд. Если после начальных кавычек написать название языка программирования, то для этого блока кода будет включена подсветка синтаксиса. Это работает не на всех платформах и не во всех редакторах, но точно работает на GitHub, StackOverflow и Discord.
Если внутри вашего кода есть тройные обратные кавычки, то окружите блок кода четверными обратными кавычками; если в них есть и четверные, то окружите пятерными, и так далее.
Создайте новую папку для этого проекта и зайдите в нее:
```
mkdir my_project
cd my_project
nano main.py
```
В новом файле напишите код для вычисления чисел Фибоначчи:
```python
def fib(n):
if n == 0:
return 0
elif n == 1:
return 1
else:
return fib(n-1) + fib(n-2)
for i in range(10):
print(fib(i))
```
Сохраните этот файл и запустите его.Создайте новую папку для этого проекта и зайдите в нее:
mkdir my_project cd my_project nano main.pyВ новом файле напишите код для вычисления чисел Фибоначчи:
def fib(n): if n == 0: return 0 elif n == 1: return 1 else: return fib(n-1) + fib(n-2) for i in range(10): print(fib(i))Сохраните этот файл и запустите его.
Для создания ссылок нужно написать видимый текст ссылки в квадратных скобках, а затем (без пробела!) в круглых скобках указать адрес ссылки.
[Одно из самых известных видео на YouTube](https://youtu.be/dQw4w9WgXcQ) превзошло 1.2 миллиарда просмотров по состоянию на 25 апреля 2022 года.Одно из самых известных видео на YouTube превзошло 1.2 миллиарда просмотров по состоянию на 25 апреля 2022 года.