Как создавать блоки уведомлений в Markdown
Markdown — это очень популярный легкий язык разметки. Он используется для написания документации и даже для создания полноценного сайта. Поэтому почти каждый из нас время от времени использует этот язык верстки.
Однако у этого языка есть некоторые ограничения. В некоторых случаях мы не можем добавить слишком много стилей или модификаций.
К счастью для нас, есть пять функций выделения для определенных сегментных блоков, таких как notice, tip, caution, important и warning. Они также применимы и в GitHub Markdown.
В этой статье я подробно расскажу об этих функциях.
Видеообзор
Если вы хотите посмотреть видео с пошаговыми инструкциями, то можете посмотреть его тут!
Как создать блок заметок в Markdown
Используйте блок Note, если хотите выделить информацию, на которую пользователи должны обратить внимание - даже если они просто бегло просматривают текст.
Чтобы написать любой сегмент, связанный с примечаниями, нужно начать его с угловой скобки ( > ), а затем указать блок выделения как Note с помощью [!NOTE].
После этого нужно добавить угловую скобку ( > ) в каждую новую строку, которую вы хотите включить в конкретный блок примечаний.
Если вы хотите закрыть блок примечаний, удалите дополнительную угловую скобку в новой строке.
> [!NOTE]
> I want the readers to read it carefully as it contains many important docs.Выходные данные:
Вы видите, что в предварительном просмотре уже есть красивый символ, связанный с заметкой.
Как создать блок советов в Markdown
Используйте блок Tip, если хотите предоставить дополнительную информацию, которая поможет пользователю добиться большего успеха.
Чтобы написать любой сегмент, связанный с советом, нужно начать его с угловой скобки ( > ), а затем указать блок выделения как Tip с помощью [!TIP].
После этого нужно добавить угловую скобку ( > ) в каждую новую строку, которую вы хотите включить в ваш конкретный блок советов.
Если вы хотите закрыть блок Tip, то удалите дополнительную угловую скобку в новой строке.
> [!TIP]
> Use the command line to detect and resolve the errors!Выходные данные:
Вы видите, что в предварительном просмотре уже есть красивый символ, связанный с советом.
Как создать блок предупреждений в Markdown
Используйте блок Warning, если хотите предоставить критический контент, требующий немедленного внимания пользователя из-за потенциального риска.
Чтобы написать любой сегмент, связанный с предупреждением, необходимо начать его с угловой скобки ( > ), а затем указать блок выделения как Warning с помощью [!WARNING].
После этого нужно добавить угловую скобку ( > ) в каждую новую строку, которую вы хотите включить в конкретный блок предупреждения.
Если вы хотите закрыть блок предупреждения, то удалите дополнительную угловую скобку в новой строке.
> [!WARNING]
> DON'T DELETE THE `package.json` file!Выходные данные:
Вы видите, что в предварительном просмотре уже есть красивый символ, связанный с предупреждением.
Как создать блок предостережений в Markdown
Используйте блок Caution, если хотите предупредить пользователей о возможных негативных последствиях того или иного действия.
Чтобы написать любой сегмент, связанный с предостережением, необходимо начать его с угловой скобки ( > ), а затем указать блок выделения как предупреждение с помощью [!CAUTION].
После этого нужно добавить угловую скобку ( > ) в каждую новую строку, которую вы хотите включить в свой конкретный блок предупреждения.
Если вы хотите закрыть блок предупреждения, то удалите дополнительную угловую скобку в новой строке.
> [!CAUTION]
> Don't execute the code without commenting the test cases.Выходные данные:
Вы видите, что в предварительном просмотре уже есть красивый символ, связанный с предостережением.
Как создать важный блок в Markdown
Используйте блок Important, если хотите предоставить важную информацию, необходимую для успешной работы пользователей.
Чтобы написать любой сегмент, связанный с важностью, нужно начать его с угловой скобки ( > ), а затем указать блок выделения как предупреждение с помощью [!IMPORTANT].
После этого нужно добавить угловую скобку ( > ) в каждую новую строку, которую вы хотите включить в конкретный блок Important.
Если вы хотите закрыть важный блок, то удалите дополнительную угловую скобку в новой строке.
> [!IMPORTANT]
> Read the contribution guideline before adding a pull request.Выходные данные:
Вы видите, что в предварительном просмотре уже есть красивый символ, связанный с важной информацией.
Заключение
Спасибо, что прочитали всю статью. Надеюсь, вы узнали что-то новое!
