1.0.0
All
1
.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
.DS_Store
|
43
.markdownlint.json
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
{
|
||||||
|
"MD013": {
|
||||||
|
"line_length": 409,
|
||||||
|
"code_blocks": false,
|
||||||
|
"tables": false
|
||||||
|
},
|
||||||
|
"MD033": {
|
||||||
|
"allowed_elements": [
|
||||||
|
"h1",
|
||||||
|
"h2",
|
||||||
|
"h3",
|
||||||
|
"h4",
|
||||||
|
"h5",
|
||||||
|
"h6",
|
||||||
|
"a",
|
||||||
|
"br",
|
||||||
|
"kbd",
|
||||||
|
"strong",
|
||||||
|
"em",
|
||||||
|
"blockquote",
|
||||||
|
"samp",
|
||||||
|
"strike",
|
||||||
|
"ins",
|
||||||
|
"table",
|
||||||
|
"tr",
|
||||||
|
"th",
|
||||||
|
"td",
|
||||||
|
"sub",
|
||||||
|
"sup",
|
||||||
|
"p",
|
||||||
|
"img",
|
||||||
|
"pre",
|
||||||
|
"picture",
|
||||||
|
"source",
|
||||||
|
"ul",
|
||||||
|
"li",
|
||||||
|
"details",
|
||||||
|
"summary",
|
||||||
|
"div"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"MD034": false
|
||||||
|
}
|
1
.prettierignore
Normal file
@ -0,0 +1 @@
|
|||||||
|
*.md
|
80
CONTRIBUTING.md
Normal file
@ -0,0 +1,80 @@
|
|||||||
|
# Руководство по взносам
|
||||||
|
|
||||||
|
1. Форк репо
|
||||||
|
2. Клонировать свой форк
|
||||||
|
3. Синхронизируйте свой локальный мастер
|
||||||
|
|
||||||
|
3.1.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git remote add upstream git@github.com:lifeparticle/Markdown-Cheatsheet.git
|
||||||
|
```
|
||||||
|
|
||||||
|
3.2.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git fetch upstream
|
||||||
|
```
|
||||||
|
|
||||||
|
3.3.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git branch --set-upstream-to=upstream/main main
|
||||||
|
```
|
||||||
|
|
||||||
|
3.4.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git pull
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Создайте ветку
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git branch issue-2 # use issue_number, replace issue-2 with appropriate branch name
|
||||||
|
git checkout issue-2
|
||||||
|
```
|
||||||
|
|
||||||
|
5. Запустите lint
|
||||||
|
|
||||||
|
```shell
|
||||||
|
markdownlint-cli2 "**/*.md" --config ./.markdownlint.json
|
||||||
|
```
|
||||||
|
|
||||||
|
6. Внесите изменения в свой форк с помощью git push
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git add .
|
||||||
|
git commit -m"Write a meaningfull commit message"
|
||||||
|
git push
|
||||||
|
```
|
||||||
|
|
||||||
|
7. Создайте запрос на выгрузку
|
||||||
|
|
||||||
|
7.1 Используйте url из терминала
|
||||||
|
|
||||||
|
```bash
|
||||||
|
remote: Create a pull request for 'issue-2' on GitHub by visiting:
|
||||||
|
remote: https://github.com/........................
|
||||||
|
```
|
||||||
|
|
||||||
|
7.2 Если у вас возникли проблемы с поиском url
|
||||||
|
|
||||||
|
a) [Markdown-Cheatsheet Pull requests](https://github.com/lifeparticle/Markdown-Cheatsheet/pulls)
|
||||||
|
|
||||||
|
b) Нажмите на кнопку 'New pull request'
|
||||||
|
|
||||||
|
c) Нажмите на ссылку 'compare acorss forks'
|
||||||
|
|
||||||
|
d) Измените головной репозиторий на ваш форк
|
||||||
|
|
||||||
|
e) Измените ветку на вашу ветку
|
||||||
|
|
||||||
|
f) Создайте pull request
|
||||||
|
|
||||||
|
8. Повторите
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git checkout master
|
||||||
|
git pull
|
||||||
|
```
|
21
LICENCE
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2016 Lilian Besson (Naereen), https://github.com/Naereen
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
BIN
MEDIA/g1.gif
Normal file
After Width: | Height: | Size: 975 KiB |
BIN
MEDIA/g2.gif
Normal file
After Width: | Height: | Size: 8.5 KiB |
BIN
MEDIA/i1.jpg
Normal file
After Width: | Height: | Size: 459 KiB |
BIN
MEDIA/i2.png
Normal file
After Width: | Height: | Size: 20 KiB |
BIN
MEDIA/i3.png
Normal file
After Width: | Height: | Size: 35 KiB |
BIN
MEDIA/i4.png
Normal file
After Width: | Height: | Size: 79 KiB |
BIN
MEDIA/i5.png
Normal file
After Width: | Height: | Size: 111 KiB |
BIN
MEDIA/i6.png
Normal file
After Width: | Height: | Size: 61 KiB |
BIN
MEDIA/i7.png
Normal file
After Width: | Height: | Size: 1.7 KiB |
BIN
MEDIA/i8.jfif
Normal file
After Width: | Height: | Size: 10 KiB |
BIN
MEDIA/i9.png
Normal file
After Width: | Height: | Size: 83 KiB |
146
OTHER.md
Normal file
@ -0,0 +1,146 @@
|
|||||||
|
- [Разное](#разное)
|
||||||
|
- [Комментарии](#комментарии)
|
||||||
|
- [Исключение символов в формате Markdown](#исключение-символов-в-формате-markdown)
|
||||||
|
- [Emojis](#emojis)
|
||||||
|
- [Перевод строки](#перевод-строки)
|
||||||
|
- [Вернуться к началу](#вернуться-к-началу)
|
||||||
|
- [Инструменты (Пока нужен интернет - переношу к нам)](#инструменты)
|
||||||
|
|
||||||
|
# Разное
|
||||||
|
|
||||||
|
## Комментарии
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Мы хотим кофе
|
||||||
|
-->
|
||||||
|
|
||||||
|
```md
|
||||||
|
<!--
|
||||||
|
Мы хотим кофе
|
||||||
|
-->
|
||||||
|
```
|
||||||
|
|
||||||
|
## Исключение символов в формате Markdown
|
||||||
|
|
||||||
|
- **Before escaping**
|
||||||
|
|
||||||
|
```md
|
||||||
|
* Звездочка
|
||||||
|
\ Обратный слеш
|
||||||
|
` Обратный знак
|
||||||
|
{} фигурные скобки
|
||||||
|
. Точка
|
||||||
|
! Восклицательный знак
|
||||||
|
# Символ тире
|
||||||
|
- Символ дефиса
|
||||||
|
() Скобки
|
||||||
|
+ Символ плюса
|
||||||
|
[] Квадратные скобки
|
||||||
|
_ Знак подчеркивания`
|
||||||
|
```
|
||||||
|
|
||||||
|
* Звездочка \
|
||||||
|
\ Обратный слеш \
|
||||||
|
` Обратный знак \
|
||||||
|
{} фигурные скобки \
|
||||||
|
. Точка \
|
||||||
|
! Восклицательный знак
|
||||||
|
# Символ тире
|
||||||
|
- Символ дефиса \
|
||||||
|
() Скобки
|
||||||
|
+ Символ плюса \
|
||||||
|
[] Квадратные скобки \
|
||||||
|
_ Знак подчеркивания
|
||||||
|
|
||||||
|
- **After escaping**
|
||||||
|
|
||||||
|
```md
|
||||||
|
\* Звездочка
|
||||||
|
\\ Обратный слеш
|
||||||
|
\` Обратный знак
|
||||||
|
\{} фигурные скобки
|
||||||
|
\. Точка
|
||||||
|
\! Восклицательный знак
|
||||||
|
\# Символ тире
|
||||||
|
\- Символ дефиса
|
||||||
|
\() Скобки
|
||||||
|
\+ Символ плюса
|
||||||
|
\[] Квадратные скобки
|
||||||
|
\_ Знак подчеркивания
|
||||||
|
```
|
||||||
|
|
||||||
|
\* Звездочка \
|
||||||
|
\\ Обратный слеш \
|
||||||
|
\` Обратный знак \
|
||||||
|
\{} фигурные скобки \
|
||||||
|
\. Точка \
|
||||||
|
\! Восклицательный знак \
|
||||||
|
\# Символ тире \
|
||||||
|
\- Символ дефиса \
|
||||||
|
\() Скобки \
|
||||||
|
\+ Символ плюса \
|
||||||
|
\_ Знак подчеркивания
|
||||||
|
|
||||||
|
## Emojis
|
||||||
|
|
||||||
|
```md
|
||||||
|
:earth_asia:
|
||||||
|
```
|
||||||
|
:sparkler:
|
||||||
|
|
||||||
|
[Полный список разметки эмодзи на github](https://www.dvurechensky.pro/dvurechensky_pro/EmojiCollectionsMarkdown)
|
||||||
|
|
||||||
|
## Перевод строки
|
||||||
|
|
||||||
|
<!-- markdownlint-disable-next-line MD038 -->
|
||||||
|
Вы можете использовать `<br>` для вставки разрыва строки. Обязательно используйте пробел ` `. Например:
|
||||||
|
|
||||||
|
```md
|
||||||
|
<table><tr><td> <br> Все любят чай. <br> </td></tr></table>
|
||||||
|
```
|
||||||
|
|
||||||
|
<table><tr><td> <br>Все
|
||||||
|
любят пить кофе и чай с печеньем
|
||||||
|
по утрам. <br> </td></tr></table>
|
||||||
|
|
||||||
|
Or
|
||||||
|
|
||||||
|
```md
|
||||||
|
<table><tr><td> <br><br><br> Все любят чай. <br><br><br> </td></tr></table>
|
||||||
|
```
|
||||||
|
|
||||||
|
<table><tr><td> <br><br><br> Все
|
||||||
|
любят пить кофе и чай с печеньем
|
||||||
|
по утрам. <br><br><br> </td></tr></table>
|
||||||
|
|
||||||
|
## Вернуться к началу
|
||||||
|
|
||||||
|
Сначала поместите следующий код в начало вашего файла с разметкой
|
||||||
|
|
||||||
|
```md
|
||||||
|
<a name="top"></a>
|
||||||
|
```
|
||||||
|
|
||||||
|
Затем используйте один из следующих кодов в том месте, где вы хотите вернуться к началу.
|
||||||
|
|
||||||
|
[Back to top](#top)
|
||||||
|
|
||||||
|
[:arrow_up:](#top)
|
||||||
|
|
||||||
|
```md
|
||||||
|
[Back to top](#top)
|
||||||
|
|
||||||
|
[:arrow_up:](#top)
|
||||||
|
```
|
||||||
|
|
||||||
|
# Инструменты
|
||||||
|
|
||||||
|
1. Создайте таблицу содержимого в формате - [binarytree](https://binarytree.dev/markdown/toc), [github-markdown-toc](https://github.com/ekalinin/github-markdown-toc)
|
||||||
|
2. Создайте пустую таблицу в формате Markdown - [Tablesgenerator](https://www.tablesgenerator.com/markdown_tables)
|
||||||
|
3. Конвертируйте Excel в таблицу Markdown - [Tableconvert](https://tableconvert.com/)
|
||||||
|
4. Предварительный просмотр Markdown для Sublime Text 3 - [Packagecontrol](https://packagecontrol.io/packages/MarkdownPreview)
|
||||||
|
5. Предварительный просмотр в формате Markdown для Visual Studio Code - [Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced)
|
||||||
|
6. Коллекция потрясающих возможностей для разметки - [Awesome Markdown](https://github.com/mundimark/awesome-markdown)
|
||||||
|
7. Markdownlint - [markdownlint](https://github.com/DavidAnson/markdownlint), [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2), [markdownlint-cli2-action](https://github.com/DavidAnson/markdownlint-cli2-action), [vscode-markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
|
||||||
|
|
||||||
|
---
|