Scroll to top
Качественное создание и продвижение сайтов To-Dev.Ru

Оформление файла README.md


SirAix - 11.07.2018 - 0 комментариев

 

Разбиение на абзацы производится вставкой пустой строки между ними.

Горизонтальная полоса между абзацами – тег <hr> – три или более звёздочек или дефисов

Первый абзац
***
Второй абзац

или

Первый абзац
---
Второй абзац


Далее – заголовки

h1 заголовок первого уровня
=====================
h2 заголовок второго уровня
-----------------------------------
### h3 заголовок третьего уровня
#### h4 заголовок четвёртого уровня
##### h5 заголовок пятого уровня
###### h6 заголовок шестого уровня

 

Оформление ссылки [Видимая часть, название ссылки] (https://to-dev.ru адрес ссылки – невидимая часть)

[Мой сайт](https://to-dev.ru)

 

Если заключить адрес в угловые скобки, то он автоматически станет ссылкой

<https://to-dev.ru>

 

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

**Жирный шрифт**
***Наклонный жирный***

 

Italic – наклонный шрифт. Пробел, знак препинания или подчёркивание отменяют правило маркера

_наклонный_ _шрифт_ _наклонный__шрифт_

 

Выделение тёмным фоном прямо в тексте

`выделенные слова`

 

Блок текста с более тёмным фоном, четыре пробела (и более) от начала каждой строки

   dir /fonts
   dir /images
   dir /js

 

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

```html
<meta name="viewport" content="width=device-width, initial-scale=1.0">
```

 

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

```php
<?php here_pagecontent(); ?>
```

 

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

```scss /* или css */
@import "bower_components/tree-normalize/generic.normalize";
h1 {
font-size:1.5em;
font-weight: 300;
}
```

 

Блок текста, выделенный тёмной полосой по левому краю (используется в качестве цитат)

> Кто-то что-то сказал
> > Кто-то ответил кому-то
> Продолжение разговора

Допустимы вложенные цитаты (цитата в цитате). Тогда цитата второго уровня выделяется двумя знаками “>>”, а цитата третьего уровня вложенности – тремя.

Таблица с чередованием светлых и тёмных строк (зебра)

Название файла  | Содержание файла
----------------|----------------------
style.css       | Пустой файл каскадной таблицы стилей, в который производится сбока необходимых стилей
reset.css       | Reset CSS от Эрика Мейера
normalize.css   | Нормалайзер CSS от Nicolas Gallagher
block.css       | Основные стили блоков системы
addition.css    | Дополнительные стили
fontawesome.css | Стили иконочного шрифта
layout.css      | Основные стили, применительно к определённому сайту
lightbox.css    | Стили лайтбокса, если таковой используется
index.html      | Индексный файл для проверки вносимых изменений

 

Листинг – ненумерованый список (<li>)

* Пункт 1
* Пункт 2
* Пункт 3

 

Нумерованный список создаётся ещё проще:

1. Пункт 1
2. Пункт 2
3. Пункт 3

Комбинируя эти маркеры вы сможете правильно разметить свой текст, сделать его более понятным.

 

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

![screenshot of sample](https://to-dev.ru/images/min.jpg)

Восклицательный знак обозначает изображение, в квадратных скобках даётся краткое описание, в обычных круглых скобках – полная ссылка на изображение.

Похожие записи

Добавить комментарий