Что такое уценка
Он определяется как программное обеспечение, написанное на Perl, которое преобразует письменный текст в HTML и, дополнительно, в синтаксис, используемый для получения ожидаемого результата HTML. Синтаксис, разработанный для того, чтобы быть простым для тех, кто хочет писать в Интернете, не нуждаясь в его знании.
Сегодня большинство обработчиков контента и даже многие почтовые клиенты изначально поддерживают использование синтаксиса Markdown с целью облегчения создания форматированного текста без необходимости реализации стилей или знания HTML., Эти обработчики используют анализатор или анализатор для преобразования текста, написанного в Markdown, в HTML.
MarkDown и документация
Это очень полезно узнать из уценки многих инструментов документации; wikia, onenote, evernote, alfresco поддерживают его как самостоятельно, так и с помощью третьих лиц. Важно иметь документацию о процессах и возможных проблемах, но более важно поддерживать их в чистоте и порядке даже с консоли, и уценка здесь, чтобы помочь нам в этом.
пункты
Если бы мы обычно писали в обычном редакторе, чтобы определить абзац, мы просто нажали бы пару:
вводить
И мы увидим, как наш курсор пройдет пару строк ниже, чтобы написать новый абзац.
В HTML это известно как
Пункт.
В Markdown это так же просто, как в обычном редакторе.
Кроме того, у нас есть преимущество в том, что один разрыв строки не разделяет текст на несколько строк, если мы напишем что-то вроде этого:
Текст. Другой текстЭто будет выглядеть так:
Текст. Другой текстИспользование нескольких разделительных линий также сводит к одному разделительному пространству между абзацами.
заголовки
В обычном редакторе нам понадобится панель инструментов, чтобы определить стиль заголовка для текста, или, если вы чувствуете себя немного грязно, было бы достаточно загрузить его с размером шрифта и сделать его жирным.
В HTML они известны как
,и т. д. заголовка.
В Markdown это очень просто, вам просто нужно поставить числовой символ (#) префикса в заголовке, в то время как больше из них имеют меньшую степень, заголовок будет максимум до 6.
Например, заголовок(самый большой) и одинОни будут написаны так: # Большой заголовок ### Маленький заголовок
и результат будет таким.
В Markdown это очень просто, вам просто нужно поставить числовой символ (#) префикса в заголовке, в то время как больше из них имеют меньшую степень, заголовок будет максимум до 6.
Например, заголовок
(самый большой) и одинОни будут написаны так: # Большой заголовок ### Маленький заголовок
и результат будет таким.
# Большой заголовок ### Маленький заголовоки результат будет таким.
Отличный заголовок
Маленький заголовок
сепараторы
Разделители обычно невозможно нарисовать в простых редакторах.
В HTML они становятся
горизонтальных правил.
Они разделяются при написании 3 или более звездочек или сценариев. За ними может следовать или разделять пробел, это безразлично.
* * * *** - - - ---
акцент
Это форматирование называется курсивом и жирным шрифтом.
В HTML это было бы и ,
Чтобы создать текст в курсивном формате, вам просто нужно заключить текст между простыми звездочками или подштрихами, а для жирного шрифта между двойными:
* Итальянский текст. * _ Итальянский текст ._ ** Жирный текст. ** __ Жирный текст .__Это будет выглядеть примерно так:
Итальянский текст жирный текст
просачивание
Это позволяет вам размещать текст так, как если бы мы его вычеркивали, много использовали для контроля версий. или ошибки, которые были исправлены в приложении или системе.
В HTML это было бы зачеркнуто.
Просто обведите текст между двойными virgulillas или тильдами:
~~ зачеркнутый текст. ~~Эта опция не является стандартной и может работать не во всех издателях.
датирование
Стиль цитирования обычно нелегко найти в обычном текстовом редакторе.
В HTML это было бы
,
Мы только должны поместить символ «больше чем» (>) в качестве префикса к тексту, который следует (аналогично адресации в Linux)> Это встреча.Это выглядело бы так:Это свидание
списки
Чтобы определить список целей, мы обычно используем функцию маркера для списков без определенного порядка и нумерованных списков.
В HTML это было быдля списков без заказа,
для упорядоченных списков и
- определить каждый элемент в списке.
В Markdown мы определяем их просто, добавляя к каждому элементу префикс звездочкой (*), дефисом (-) или плюсом (+) для неупорядоченных списков. Для упорядоченных списков мы ставим префикс с соответствующим номером и точкой:* Написать учебник * Опубликовать его в Solvetic. 1. Новый учебник. 3. Выберите раздел и уровень. 2. Исправьте форматы и опубликуйте.Это будет выглядеть так:
- Написать учебник
- Отправьте это в Solvetic.
Перечисленная иерархия не соответствует иерархии числа, позиция внутри них будет использоваться.
- Новый учебник
- Выберите раздел и уровень.
- Исправьте форматы и опубликуйте.
связи
Размещение ссылок чрезвычайно полезно и важно, так как позволяет ссылаться на содержимое какой-либо внешней документации или учебного пособия.
пример:Сервер Nginx был защищен с помощью fail2ban с помощью [tutorial-solvetic] (http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y-nginx/)Мы заключаем в скобки [] текст, который мы хотим иметь ссылку, а затем помещаем ссылку назначения в скобки () .
Если вы предпочитаете делать это более упорядоченно, чем ссылки в середине текста, вы также можете сделать это следующим образом:Сервер Nginx был защищен с помощью fail2ban с помощью [1] ... ... ... [1]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo- with-ssh-y-nginx /Другой вариант будет:Сервер Nginx был защищен с помощью fail2ban с использованием [fail2ban-nginx-solvetic] ... ... ... [ssh-nginx-solvetic]: http://www.solvetic.com/tutoriales/article/1963-install -fail2ban-and-associate-with-ssh-y-nginx /Теперь добавьте изображения.
образность
Мы можем добавить изображения, почти похожие на ссылки, добавив! перед каждым я должен подчеркнуть, что не вижу их из терминала, а не напрямую.! [альтернативный текст] (url-of-image)Мы можем использовать те же параметры ссылок, если хотим, чтобы они были более упорядоченными.
рисовать
Я обычно размещаю данные доступа в таблицах серверов или сервисов.
Для этого мы рисуем линии таблицы с помощью каналов (|) для разделения столбцов и тире (-), чтобы отделить заголовок от остальных строк:| Сервис | Имя пользователя Ключ | | ------------- | --------- | ----------- | | FTP | решающий | aw-D.wak | | SSH | admin | 2 -.- am, |У нас было бы что-то вроде этого: $config[ads_text5] not found
Нет необходимости выравнивать трубы, а «края» необязательны, например:Заголовок 1 | Заголовок 2 --- | --- давайте попробуем | что-нибудь давай попробуем | в противном случае это сгенерирует ту же таблицу.Вы также можете выровнять текст ваших столбцов, поместив символ двоеточия ( в разделителе, выполненном штрихами на стороне, которую вы хотите выровнять:| Выстроились влево | По центру | Выровнено по правому краю | |: ------------------- |: --------: | ----------------- -: | | тест | тест | тест |Не все издатели принимают таблицы в Markdown.
код
Мы можем выделить наш код с уценкой и различием от одного языка к другому.Синтаксис тройного обратного удара
Поместить блоки этого типа очень просто, нам просто нужно заключить блок кода, который мы хотим, между 3 обратными чертами (``), за которыми следует имя языка, к которому принадлежит код, который вы хотите разместить:`` language x = y ... ''Пример кода в JavaScript будет примерно таким:`` js function test () {console.log ('testing!')} `` `Это сгенерирует хороший блок кода с выделенным синтаксисом для javascript:function test () {console.log ('testing!')}Синтаксис перед интервалом
Другой способ размещения предварительно отформатированного текста или кода, но без указания языка, состоит в том, чтобы «вставлять» наш текст в 4 пробела, мы бы написали его так:x = y // обратите внимание, что между полем и тем, что мы пишем, есть 4 пробела.У нас будет такой результат:x = y // обратите внимание, что между полем и тем, что мы пишем, есть 4 пробела.Стандарт принимает опцию только с предварительным интервалом.
выводыХорошая система документации должна быть быстрой, гибкой и простой. Пункты, которые уценка охватывает очень хорошо, мы не должны забывать ваш синтаксис чистого глаза, что следует учитывать, если мы хотим просмотреть документацию с терминала, использующего VIM / EMACS. Эта статья предназначена для системных администраторов, но может быть очень полезна для профессионалов и студентов всех типов. Надеюсь, любые сомнения или предложения ясны, оставьте это в комментариях.
- 0
СТАТЬИ