Skip to content

Latest commit

 

History

History
126 lines (85 loc) · 5.51 KB

Форматирование.md

File metadata and controls

126 lines (85 loc) · 5.51 KB
icon tags
note
guide

Форматирование

Страницы в формате Markdown .md представляют собой обычные текстовые документы с простым читаемым синтаксисом, который помогает делать написание для интернета проще.

Для создания файла .md не требуется специальное программное обеспечение. Достаточно использовать обычный текстовый редактор. Просто сохраните файл с расширением .md.

Пожалуйста, посетите markdownguide.org для полного демонстрации возможностей форматирования и лучших практик.

!!! Просмотрите фактический файл formatting.md, использованный для создания этой страницы. !!!


Быстрый старт

Приведенный ниже пример демонстрирует очень простую страницу sample.md с заголовком и одним абзацем.

# Заголовок страницы здесь

Это абзац.

Мы можем развить предыдущий пример, добавив больше контента и форматирования, такие как жирный текст, изображения и списки.

# Page title here

This is a paragraph.

Both [internal](README.md) and [external](https://example.com) links work.

![Your logo](logo.png)

Another paragraph with **bold**, _italic_, ~~strikethrough~~, and `code` samples.

---

## Списки

- Первый элемент
- Второй элемент
- Третий элемент

1. Первый элемент
2. Второй элемент
3. Третий элемент

> "Здорово! Это цитата."

!!!
Хотите привлечь внимание к чему-то? Используйте предупреждение.
!!!

На очень простом уровне, чтобы создать новую страницу для вашего проекта Retype, выполните следующее:

  1. Создайте файл readme.md
  2. Добавьте заголовок с помощью # Заголовок
  3. Начните писать

Главная страница

Ваш проект должен включать файл по умолчанию (index.md, default.md, readme.md или welcome.md) в корне проекта. Если в корневой папке есть файл по умолчанию, Reborn будет использовать эту страницу в качестве главной. Нажатие на логотип или заголовок в верхнем левом углу будет переходить на главную страницу.

Вне корня вашего проекта добавление файла с точно таким же именем, как у папки, также будет действовать как страница по умолчанию для этой папки. Например, добавление /guides/guides.md эквивалентно /guides/index.md.

Файлы по умолчанию можно использовать в любой папке проекта. Учитывая следующую структуру папок и файлов, где Guides - это папка...

|-- Guides
    |-- index.md
    |-- getting-started.md
|-- readme.md

...Retype создаст три страницы на вашем веб-сайте, и страницы будут доступны по следующим адресам:

  1. /
  2. /guides/
  3. /guides/getting-started/

!!! Если ваша главная страница - это сгенерированная Retype страница Welcome, добавьте страницу по умолчанию в корень вашего проекта. Файл главной страницы может называться index.md, default.md, readme.md или welcome.md. !!!

Компоненты

В дополнение к стандартным возможностям Markdown, Retype включает множество пользовательских компонентов, чтобы вы могли легко добавлять дополнительные [!badge 💎 элементы 💎] на свой документ.

Наиболее часто используемыми компонентами Retype являются Alert и Tab:

Предупреждение

!!! Это предупреждение !!!

!!!
Это предупреждение
!!!

Вкладка

+++ Вкладка 1 Это Вкладка 1 +++ Вкладка 2 Это еще одна Вкладка +++

+++ Вкладка 1
Это Вкладка 1
+++ Вкладка 2
Это еще одна Вкладка
+++

!ref Посмотреть все компоненты