Как сделать стилизованный ящик с инструкциями Markdown в GitHub Gist?
Я пытаюсь создать окно с предупреждениями Markdown, например поле для заметок, окно с предупреждением для GitHub Gist. Я выполняю поиск в Google и нахожу наставления по уценке Python, но эти наставления, похоже, не работают на GitHub Gist.
Я пытался следовать предупреждению Python, но этот синтаксис уценки не работает на GitHub Gist.
!!! Hello Admonition
Я также попробовал загрузочные коробки, как это, но у них нет стиля, как ожидалось:
<div class="alert alert-danger" role="alert">
<div class="row vertical-align">
<div class="col-xs-1 text-center">
<i class="fa fa-exclamation-triangle fa-2x"></i>
</div>
<div class="col-xs-11">
<strong>Error:</strong>
</div>
</div>
</div>
Есть ли какой-нибудь синтаксис предупреждений или метод HTML-кода для GitHub Gist?
11 ответов
Используйте смайлики, чтобы привлечь внимание пользователя
> :warning: **If you are using mobile browser**: Be very careful here!
Вот список других смайликов (просто скопируйте и вставьте):
https://gist.github.com/roachhd/1f029bd4b50b8a524f3c
Или вы также можете использовать уценку GitHub:
Хотя это не совсем предупреждение, это поддерживается (бета-тестирование) с мая 2022 года, как сообщил Диего Хаз и описано в обсуждении 16925.
Чтобы лучше выделять и отделять определенную информацию от остальной в вашей документации на GitHub, теперь мы отображаем специальное и доступное примечание или цитату с предупреждением в документах Markdown.
Мы используем существующий синтаксис для блочных цитат и полужирного текста.
Первая строка должна быть именно такой, как показано ниже.
Первая буква чувствительна к регистру. Вторая строка может содержать ваш контент.Этот ввод:
> **Note** > This is a note > **Warning** > This is a warningСтановится:
Предупреждение: синтаксис может все еще развиваться и обсуждается в обсуждениях. Например, Брентон М. Верник комментирует :
В дополнение к проблемам синтаксиса и проблемам семантической сети, поднятым другими, я также обеспокоен тем, что это приводит к серьезной несовместимости между GitHub-Flavored Markdown и pandoc markdown или CommonMark.
Большое количество разработчиков R пишут README и другую документацию в RMarkdown, который обычно обрабатывается с помощью pandoc.
Это изменение будет означать, что пользователи не смогут получить согласованный рендеринг с одним и тем же синтаксисом, когда документация их пакета отображается на GitHub, а не где-либо еще.
Перегрузка цитаты таким образом создает непрозрачную разницу в значении синтаксиса между разновидностями уценки, которую очень сложно описать разработчикам.
Вы можете создать коробку с жирным текстом, используя таблицы, например:
| WARNING: be careful to baz the quux before initializing the retro encabulator! |
| --- |
Это выглядит так:
Это немного злоупотребление синтаксисом, но это работает. К сожалению, нет никакого способа применить другое форматирование, например, цвета, как заметил Крис.
Большинство репозиториев, в которых я был отдельно, используют цитату для симуляции наставления:
> **WARNING**: Be careful, or else!
Ниже приведен пример его использования в верхней части, а также внутри раздела:
ht tps:https://stackru.com/images/237512e361d7c71a64b4d2f144628da84a971611.png
В стандартной уценке с использованием символа UTF8 это выглядит неплохо:
> **⚠ WARNING: Aliens are coming.**
> A description of the colour, smell and dangerous behaviour of the aliens.
Это выглядит так:
⚠ ВНИМАНИЕ: приближаются пришельцы.
Описание цвета, запаха и опасного поведения пришельцев.
GitHub Flavored Markdown не имеет ничего подобного, и его HTML, сгенерированный или встроенный, подвергается агрессивной дезинфекции.
Скорее всего, вам придется обходиться с основами, например,
_**Warning:** Be very careful here._
или же
### Warning
Be very careful here
Самый простой способ:
| This project was moved and hosted on Render. |
|----------------------------------------------|
Приведет к:
Вы можете использовать таблицы или цитаты (проверено только на Gitlab и Github):
Использование таблицы
| ⚠️ Warning |
|------------------------------------------|
| You shouldn't. This is irreversible! |
| ❌ Error |
|------------------------------------------|
| Don't do that. This is irreversible! |
| ℹ️ Information |
|------------------------------------------|
| You can do that without problem. |
| ✅ Success |
|------------------------------------------|
| Don't hesitate to do that. |
| New line support |
|-------------------------------------------|
| It supports new lines:<br/>.. simply use `<br/>` for new lines|
Использование цитаты
> **⚠️ Warning**
>
> You shouldn't. This is irreversible!
> **❌ Error**
>
> Don't do that. This is irreversible!
> **ℹ️ Information**
>
> You can do that without problem.
> **✅ Success**
>
> Don't hesitate to do that.
> ** New line support**
>
> It supports new lines:
>
> .. simply use an empty `>` line
>
Вы можете использовать SVG с соответствующим цветным значком и текстом. Например, код
> <picture>
> <source media="(prefers-color-scheme: light)" srcset="https://github.com/Mqxx/GitHub-Markdown/blob/main/blockquotes/badge/light-theme/warning.svg">
> <img alt="Warning" src="https://github.com/Mqxx/GitHub-Markdown/blob/main/blockquotes/badge/dark-theme/warning.svg">
> </picture><br>
>
> Warning
урожайность
Еще несколько примеров можно найти здесь .
По сравнению с бета-решением Github , это решение не сломается, если Github вернет предложенный синтаксис. Однако он сломается, если репо выйдет из строя; хотя можно, конечно, его клонировать. Кроме того, поскольку это SVG, вы не можетеctrl + fи искатьwarning.
Вы можете это оповещение в вашем md файле
https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types
Простое выделенное предупреждение может быть получено следующим образом:
>[!WARNING]
>This is a warning
Вот как это выглядит: