Руководство по Markdown, языку форматирования Интернета
Помимо редакторов форматированного текста: чисто, быстро и просто
(Почти) все веб-сайты имеют корни в HTML или языке гипертекстовой разметки, но его сложная система на основе тегов является излишней для любого, кто хочет форматировать контент, который не заинтересован в изучении всего языка. Markdown, созданный в 2004 году Джоном Грубером и Аароном Шварцем, представляет собой игру над буквой «M» в HTML - был создан как альтернатива HTML, в котором использовался минималистский синтаксис для создания аккуратного и чистого форматирования. Поскольку он был настолько доступен в Интернете не как набор веб-страниц, а как сообщество, он был принят платформами по всему Интернету как быстрая и многофункциональная альтернатива неуклюжим редакторам форматированного текста.
Например, рассмотрим StackOverflow, возможно, самый популярный сайт помощи для разработчиков (и множество других сайтов Overflow, посвященных науке, политике, математике и многому другому). Вопросы форматируются с использованием уценки, и как вопросы, так и ответы, которые правильно используют разнообразный набор команд уценки, с большей вероятностью получат ответ или проголосуют за.
Reddit, часто описываемый как питательная среда Интернет-культуры, использует Markdown как метод создания сообщений, который может позволить вам создавать сложные структуры, такие как таблицы и сноски, экспоненциально быстрее по сравнению с более стандартным редактором форматированного текста, без необходимости неуклюже щелкать вокруг кнопок.
Еще один пример - Jupyter notebook, одна из лучших сред программирования для языков Julia, Python и R. И ячейки кода, и ячейки уценки включены, чтобы позволить разработчикам аннотировать свой код и визуализации с помощью математических выражений и других структур, таких как флажки, для отслеживания развития кода и логики.
Помимо этого, Markdown используется для создания веб-сайтов, документов, заметок, книг, презентаций, электронных писем и технической документации. Markdown является портативным и динамическим, а файлы, содержащие текст в формате Markdown, можно открывать с помощью любого приложения, от вашего любимого текстового редактора до Word. Язык форматирования есть везде в Интернете.
Изучение Markdown - это просто и большой плюс, так что давайте приступим к делу!
Выбор редактора
Если вы хотите использовать Markdown для заметок или создания веб-сайта, загляните в формальный редактор, такой как Dillinger. Эти редакторы позволяют вводить Markdown, просматривать выходные данные HTML и экспортировать их в файлы различных типов, такие как .md или .pdf.
Если вам не нравится использовать онлайн-редактор, файлы Markdown можно хранить с расширениями файлов .md или .markdown, и их можно читать практически любым текстовым редактором, от Блокнота до Скобок. Затем вы можете просмотреть обработанную версию кода в своем браузере (в конце концов, Markdown - это упрощенный интерфейс для доступа к возможностям форматирования HTML).
В противном случае найдите другой процессор, в котором вы, вероятно, будете его использовать (предположительно, онлайн-платформу). Например, в Kaggle (онлайн-оператор записной книжки Jupyter) ячейки кода можно преобразовать с помощью «Изменить ячейку на уценку». В локальных средах записной книжки Jupyter типы ячеек можно редактировать из ячейки кода в ячейку уценки.
StackOverflow также имеет функцию предварительного просмотра Markdown для кода в текстовом поле вопроса.
Стандартный стиль
Пожалуй, самый простой элемент уценки - это заголовок. Цифровой символ # используется для обозначения заголовков различных размеров и эквивалентен HTML-тегам от <h1></h1> до <h4></h4>. Многие приложения не согласны с тем, как справиться с нехваткой места между символом числа и текстом (#text), поэтому рекомендуется размещать пробел между символом и текстом.
# largest heading ## medium heading ### small heading #### tiny heading
Обычный текст абзаца, представленный в HTML с помощью тегов <p></p>, можно просто ввести в ячейку кода. Чтобы создать разрыв строки, добавьте пустую строку между двумя текстами.
This is regular paragraph text. This is text on a new line.
Хотя курсив и полужирный шрифт предлагаются большинством редакторов markdown, их легко записать звездочками (* для курсива, ** для полужирного). Это эквивалентно <em> и <strong> в HTML соответственно.
This is **bolded** text, this is *italicized* text. I can also nest ***bolding and italicizing***.
Вдобавок двойные тильды ~~ создают зачеркивание. Как и другие элементы стиля, эти теги используют открывающие и закрывающие теги и могут быть вложены в другие элементы.
~~The Earth is flat.~~
Использование блочных кавычек можно использовать для цитирования чего-либо из текста или сказанного кем-то. Это делается с помощью стрелки вправо >. Множественные стрелки вправо можно использовать для формирования вложенных блочных кавычек.
> This is a block quote > You can also use > > nested block quotes and other **emphasis**.
Горизонтальные правила - это линии, проходящие по ширине экрана. Они могут быть выполнены с помощью трех звездочек (***), трех тире (---) или линии, образованной символами подчеркивания (_________________). Все дают одинаковый результат.
#### Section 1 --- #### Section 2
Списки
Упорядоченные списки можно использовать для перечисления элементов в определенном порядке. Использование стандартных вкладок может помочь создать подсписки с отступом.
1. First item
1. Nested item
2. Nested item 2
2. Second item
Неупорядоченные списки также являются списками элементов, но неупорядоченными (маркеры). Markdown принимает любой из трех символов - -, +, * - в качестве маркера. Как и упорядоченные списки, они могут быть вложенными.
- First item
+ Nested item
* Nested item
Вкладки могут использоваться для включения других элементов в различные иерархии, которые могут включать в себя любой элемент, например блочные кавычки, или смешивание упорядоченных и неупорядоченных списков.
- First item
1. A subpoint.
+ Another subpoint.
* Yet another subpoint.
> This is a block quote.
Флажки можно использовать для обозначения списка с элементами, которые были завершены или незавершены. Это обозначается квадратными скобками, содержащими либо пробел, либо x, за которым следует маркер.
- [x] Task 1 - [ ] Task 2 - [x] Task 3
Код
Блоки кода, аналогичные тегам <code> в HTML, могут быть помечены символом обратной кавычки: ` (вы можете найти его в левом верхнем углу клавиатуры).
#### Intro to Python 1. Open a Python console. 2. Type `print(“hello world!”)`. 3. Press `Enter`.
Кроме того, можно создать ограждения кода для формирования блоков кода, которые охватывают несколько строк вместо слов с тремя обратными кавычками (```) для открытия и закрытия ограждения кода.
#### HTML Code Sample ``` <h1>My First Heading</h1> <p>My first paragraph.</p> ```
Связывание
Чтобы создать гиперссылку, поместите текст гиперссылки в квадратные скобки [], а затем URL-адрес в скобках ().
#### How to Search 1. Go to [Google](https://www.google.com). 2. Enter a query in the search bar. 3. Press `Enter`.
Некоторые редакторы поддерживают использование сносок, заключенных в две квадратные скобки ([]) и стрелку вверх (^), за которой следует номер ссылки. Щелчок по этой ссылке приведет к переходу страницы к описанию сноски, которое имеет тот же символ, за которым следует точка с запятой, чтобы добавить определение.
Here's a simple footnote,[^1]
[^1]: This is the first footnote.
Чтобы автоматически превратить любой URL-адрес или электронную почту в интерактивную ссылку, заключите ее в стрелки влево и вправо.
Email us at <[email protected]>.
Дополнительные возможности
Таблицы - важная часть передачи информации. Формат таблицы может отличаться в зависимости от процессора, на котором выполняется уценка.
| Column1 | Column2 | | --- | --- | | Value1 | Value2 | | Value3 | Value4 |
Большинство процессоров уценки могут обрабатывать LaTeX, который производит красивую стилизованную математику. Это может быть активировано в строке с помощью знаков доллара $ или полных фрагментов кода с открытием \[ и закрытием \]. Вы можете узнать больше о синтаксисе LaTeX здесь.
Math: $\sum^{n}_{i=0}{i^n + \log(i)} + \pi^{\exp(n)}$
С другой стороны, если уценка не поддерживает определенные функции HTML, которые вы хотели бы включить, большинство процессоров уценки также могут обрабатывать HTML-теги.
Использование Markdown
Поздравляю, все готово! Markdown - чрезвычайно простой и минималистичный язык форматирования, и вы выучили практически все, что вам нужно, на этом языке.
- Если вы думаете об использовании Markdown для размещения страниц документации или ведения блога, обратите внимание на Jekyll, который принимает Markdown (среди других более продвинутых методов форматирования) и выводит статический сайт. Это позволяет использовать бесплатный веб-хостинг, поскольку он интегрирован со страницами GitHub.
- Если вы хотите написать книгу (или статью на более длинной стороне) с помощью Markdown, Leanpub позволяет пользователям отправлять файлы Markdown, которые Leanpub будет публиковать в электронной форме в различных типах файлов под веб-адресом.
- Если вы используете Markdown, чтобы быстро задавать вопросы о StackOverflow, загружать контент на Reddit и использовать еще одно из его бесчисленных приложений в Интернете от Gmail до Github, продолжайте и удивляйте своих друзей своими новыми навыками!
Если вам понравилось,
Вам также могут понравиться учебники по LaTeX для математического форматирования и написания научных статей соответственно. LaTeX, более сложный, но все же легко усваиваемый язык форматирования, профессионально используется многими престижными академическими учреждениями по всему миру для повышения качества своих статей от стандартных до красивых с невероятной легкостью обработки математических выражений и стандартных элементов документов, таких как Оглавление, благодарности, сноски. , цитаты и многое другое.
