Все, что вам нужно знать, чтобы писать README.MD
Когда я только начинал работать с Github, мне всегда было интересно, как люди могут узнать о уценке? Мне показалось, что это совершенно чуждый язык с использованием «#» или «##». Я думал, что никогда не смогу выучить этот язык, по крайней мере, в этой жизни. Кто знал, что я ошибаюсь. Если вы похожи на меня и думаете, что тоже не можете изучить синтаксис разметки Github, возможно, вы ошибаетесь. Итак, в этой статье мы узнаем о синтаксисе разметки Github и о том, что такое уценка в целом. Итак, начнем.
Что такое Markdown?
Прежде чем мы начнем что-либо изучать, мы должны знать, что это такое. Markdown - это легкий язык разметки, который мы можем использовать для добавления форматирования к текстовому документу в Интернете. Мы можем преобразовать текст в курсив, полужирный или подчеркнутый, а также можем создавать списки, ссылки и заголовки, используя буквенно-цифровые символы, такие как «*» и «#». Иногда мы также используем markdown в качестве утилиты для преобразования файлов в HTML (язык гипертекстовой разметки).
Он был разработан Джоном Грубером в 2004 и является почти самым популярным языком разметки в мире. Markdown часто используется для форматирования файлов README.md, для написания сообщений в сетевых дискуссионных форумах и для создания полноформатных сообщений. Как и в Dev.to, вы можете писать и форматировать сообщения только с помощью markdown. . Да, и не забудь пойти за мной и туда! 😜
Если вы хотите получить шпаргалку по уценке совершенно бесплатно, вы можете щелкнуть здесь, чтобы загрузить копию с Collectiveray.com - Шпаргалка по уценке.
Уценка со вкусом Github (GFM).
Github выпустил собственный язык уценки на основе оригинальной уценки. GFM предоставляет дополнительный набор полезных функций, многие из которых упрощают работу с контентом на GitHub.com. По большей части это почти то же самое, что и уценка.
Синтаксис Markdown
Заголовок
Почти в каждом текстовом документе вы увидите заголовки. Как и в случае с Html в markdown, у нас также есть шесть заголовков в зависимости от их размера (H1-H6). Синтаксис заголовков - «#».
# heading 1 ## heading 2 ### heading 3 #### heading 4 ##### heading 5 ###### heading 6
Жирный текст
В Markdown мы используем «**…. **», чтобы сделать текст жирным.
**This will be Bold**
Курсивный текст
В Markdown мы используем «*…. *», Чтобы сделать текст курсивом.
*This will be italic*
Курсив и полужирный текст
В Markdown мы используем «***…. ***», чтобы сделать текст курсивом.
***This will be both bold and italic***
Списки
Как и в случае с Html в markdown, у нас также есть два типа списков.
- Упорядоченный список
- Неупорядоченный список
Итак, давайте обсудим их обоих.
Упорядоченный список
В уценке мы можем легко создать упорядоченный список способом, указанным ниже.
1. item 1 2. item 2 3. item 3 1. sub-item 1 of item 3 2. sub-item 2 of item 3
Неупорядоченный список
В markdown мы можем легко создать неупорядоченный список способом, описанным ниже.
* item 1 * item 2 * item 3 * sub-item 1 of item 3 * sub-item 2 of item 3
Ссылки
В markdown мы можем создавать ссылки, используя «[Название веб-сайта] (адрес веб-сайта)».
[Github](https://www.github.com)
Изображений
В markdown мы можем создавать ссылки, используя «! [Альтернативный текст для изображения] (адрес изображения)»
BlockQuotes
В уценке мы используем «› »для написания кавычек.
As Albert Einstein said: > Insanity is repeating things and excepting different results.
Последовательности побега
В markdown есть некоторые слова, которые являются синтаксисом markdown, и что, если они нам понадобятся в нашем тексте? Чтобы написать слова, которые являются синтаксисом уценки, мы должны использовать «\» перед этими словами, и эти слова
\ backslash
` backtick
* asterisk
_ underscore
{} curly braces
[] square brackets
() parentheses
# hash mark
+ plus sign
— minus sign (hyphen)
. dot
! exclamation mark
Заключение
Это был важный синтаксис, который вам понадобится большую часть времени. Это не полная шпаргалка по уценке, возможно, еще осталось немного. Я думаю, этого вполне достаточно, чтобы выполнить вашу работу, и большинство людей никогда не выходят за рамки этого. Надеюсь, вы кое-что узнали из моей статьи. Если вы хотите узнать больше о уценке, ознакомьтесь с этой шпаргалкой от Github, где вы также познакомитесь с некоторыми синтаксисами GFM. Чтобы попрактиковаться в уценке, попробуйте это приложение.
