Phenquestions
Стандартният Markdown
Markdown е стандарт, разработен от Джон Грубер. Основната цел на Markdown е да направи файла възможен за четене дори в чист текст. Ако искате да търсите в текстов редактор, трябва лесно да го прочетете. Това е много полезно за потребителите на vim и подобни. Обърнете внимание и не забравяйте, че това е стандарт за промяна на текстови файлове. Той не замества HTML. Вместо това го използвате за създаване на HTML, където е полезно. В случая с GitHub те ще форматират файла Readme на сайта. Докато спазвате стандарта, можете да сте сигурни, че той ще изглежда добре.
Тъй като GitHub е добавил само няколко разширения, трябва да започнете с помощта на извадка на Markdown и да отидете от там. Ето списък на най-често срещаните.
| Маркдаун | Разширения | Резултат |
| # (1 на ниво) | Заглавия | |
| * | Курсив | |
| ** | Удебелен | |
| > | Блок цитат | |
| 1. (и т.н.) | Подреден списък | |
| - | Неуреден списък | |
| „код“ | Вашият код | |
| „ | Md-вътр | Стартиране и край на кодов блок |
| - | Хоризонтално правило | |
| [Описание] (https: // www.пример.com) | Име в квадрат и URL в обикновени скоби | |
| ![алтернативен текст] (изображение.png) | Същото, връзка към изображение | |
| [1] | Md-вътр | Бележка под линия |
Списъците могат да бъдат вложени чрез отстъпване на всички елементи, които искате да са вложени.
Други разширения за обикновен Markdown, имате разширенията за кодове по-горе. Те не винаги се поддържат от услуги.
| Маркдаун | Разширения | Резултат |
| ### Заглавие # custom-id | Md-вътр | Заглавие, към което можете да се обърнете по неговия идентификатор |
| термин: определение | Md-вътр | Списък на термините с дефиниции |
| ~ Грешен текст ~ | Md-вътр | Пречертан текст |
| - [x] Задача за изпълнение | Md-вътр | Списък със задачи, който можете да маркирате |
Таблицата е много проста, но ви трябват няколко реда, за да я покажете: Таблица:
| Име | СТОЙНОСТ || ----------- | ---------- |
| Постелки | 100 |
Разширения на GitHub.
GitHub е добавил няколко разширения, за да улесни обработката на връзки към други хора и проекти. Някои от тях са таблиците, споменати по-рано. Това, което ще ви помогне най-много, е разширението за автоматично свързване. Той създава връзка самостоятелно, когато го използвате на GitHub.
Други са таблици и елементи от списъка със задачи. Те са удобни за проследяване на вашите задачи в проекти. Последното, което трябва да се спомене, е разширението Disallowed Raw HTML. С помощта на това разширение някои маркери се филтрират при изобразяване за HTML. Тези маркери могат да предизвикат странни ефекти при изобразяване в GitHub.
Начини за изследване на GitHub Markdown
Ако ви се струва объркващо, можете също да отидете на страницата на GitHub и да използвате вградения редактор. Когато го използвате, той автоматично ще завърши някои функции. Това работи само за проблеми, но можете да го използвате, за да разберете някои неща, емотиконите излизат като списък, когато пишете двоеточие (:).
Можете също така да намерите проект на GitHub, който има страхотно изглеждащ README файл и да го клонирате на вашето локално устройство. Оттам можете да изследвате файла с помощта на всеки редактор, който желаете. За големите редактори, Emacs и Vim, има поддръжка за намаление чрез разширения.
Ако използвате vim, можете да поставите разширение за подчертаване на синтаксис от GitHub, vim-markdown. Това разширение ви показва, че сте направили правилно кода. За да ви помогне да видите как изглежда, когато сте готови, можете също да получите разширението на живо. С това можете да стартирате уеб сървър, който показва резултата на живо, докато пишете.
С Emacs имате режим на нетърпеливост, режим на изчакване и преглед в реално време. Всички те показват резултантната ви страница в браузър, докато пишете. Първият изисква по-малко библиотеки от втория, но се нуждае от допълнителен кодов фрагмент за изпълнение.
Заключение
Въпреки че намалението е малка и умишлено проста спецификация, може да е малко объркващо да започнете. Най-добрият начин да научите е да използвате мамят лист и да напишете вашия документ Markdown. Можете да актуализирате README.md на GitHub и можете да получите много подкрепа от вградените функции на редакторите ви. Като странична бележка GitHub също поддържа емотикони, които можете да добавите към вашия документ. Можете да използвате мамят, за да намерите кои са те.
Изтеглете Markdown-CheatSheetHere
