Перейти до змісту

Огляд

Необхідні умови:

  • Використання Markdown.
  • Знання Markdown.

Цей посібник демонструє популярні теги Markdown, які використовуються на https://docs.rockylinux.org, і містить тег admonitions, який не є частиною стандартних тегів Markdown.

Демо

Це приклад цитати. Гарно відформатований.

Іноді ви побачите це.

Як щодо маленького bold face

У більшості випадків це прямий текст.

Іноді потрібно показати команду

Або кілька команд:

dnf install my_stapler
dnf update my_pencil
dnf remove my_notepad
systemctl enable my_stapler

В інших випадках вам потрібні марковані або пронумеровані списки:

  • Думаю, у вас є мій степлер
  • Якщо подумати, я навіть не можу знайти свій компас
  • Якщо ні, будь ласка, принаймні поверніть мені олівець
  • Мені це точно потрібно

  • Я не знав, що тобі це потрібно

  • Ось твій зламаний олівець
  • Заточувати його марно

І вам може знадобитися попередження:

Попередження

Застереження є чудовим вибором для включення додаткового вмісту без значного переривання потоку документів. Матеріал для MkDocs надає кілька типів попереджень і дозволяє включати та вкладати довільний вміст.

ПІДКАЗКА

Олівці та степлери - це стара школа.

Використання

Застереження мають простий синтаксис: блок починається з !!!, за яким йде ключове слово, яке використовується як кваліфікатор типу. Вміст блоку наводиться в наступному рядку з відступом на чотири інтервали:

Примітка

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Зміна назви

За замовчуванням заголовок дорівнюватиме кваліфікатору типу в регістрі заголовка. Однак його можна змінити, додавши рядок у лапках, що містить дійсну позначку (включно з посиланнями, форматуванням тощо) після кваліфікатора типу:

Phasellus posuere in sem ut cursus

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Часто, коли команда має кілька параметрів або вам потрібно вказати особливості, ви можете використовувати таблицю для визначення речей:

ІнструментВикористанняДодаткова інформація
олівецьнаписання або друкчасто замінюють пером
перонаписання або друкчасто замінюють стилусом
стилусзапис або друк на електронному пристроїіноді замінюється клавіатурою
клавіатуразапис або друк на електронному пристроїжодного разу не замінювали - використовували до повного наповнення харчовими крихтами
блокнотробити нотаткизамінити інколи несправну пам’ять

Author: Steven Spencer

Contributors: Wale Soyinka, Tony Guntharp