Правила оформлення файлу на github

Правила оформлення файлу README.MD на GITHUB

Правила оформлення файлу на github
Якщо ви почали роботу на GitHub, вирішили завантажити туди свій проект для спільної роботи з однодумцями, то, швидше за все, в першу чергу перед вами постане проблема створення першого файлу - файлу «readme.md».

Для форматування тексту на GitHub використовуються досить прості правила. Я перерахую основні і достатні, тому що не претендую на повноту офіційного керівництва.

Стилістична розмітка повинна бути такою:

Розбиття на абзаци проводиться вставкою порожнього рядка між ними (натисніть "Enter" після абзацу).

Горизонтальна смуга між абзацами - тег

- три або більше зірочок або дефісів

Далі - заголовки та інше:

Виділення жирним шрифтом

Виділення темним тлом прямо в тексті

Блок тексту з більш темним тлом, чотири пробілу (і більше) від початку кожного рядка

Блоки тексту з подвеченним синтаксисом. Виділений кольором фону блок з html-кодом. Теги виділяються кольором за правилами html

Виділений кольором фону блок з php-кодом. Теги виділяються кольором за правилами php

Виділений кольором фону блок з каскадними таблицями. Теги виділяються кольором за правилами css

Блок тексту, виділений темною смугою по лівому краю (цитата)

Допустимі вкладені цитати (цитата в цитаті). Тоді цитата другого рівня виділяється двома знаками ">>", а цитата третього рівня вкладеності - трьома.

Таблиця з чергуванням світлих і темних рядків (зебра)

  • Лістинг - ненумерований список

    Нумерований список створюється ще простіше:

    italic - похилий шрифт. Пробіл, знак пунктуації або підкреслення скасовують правило маркера

    Комбінуючи ці маркери ви зможете правильно розмітити свій текст, зробити його більш зрозумілим.

    Вставка зображення в текст

    Схожі записи: Різновиди логотипів і їх стилі.
    Любов і ненависть в CSS
    Ручне сортування публікацій в Ruxe Engine
    Аксіоматичний CSS. Частина 3. Синтаксис.
    Аксіоматичний CSS. Частина 2

    Схожі статті