Как установить Mermaid для рендеринга блок-схем в markdown?
Я пытаюсь отобразить блок-схему в файле markdown с помощью Mermaid. У меня есть ... ReadMe.md файл в моем репозитории GitHub, и я хотел бы включить базовую блок-схему, чтобы помочь описать содержимое. Но я не могу понять, как заставить его работать. Сможет ли кто-нибудь опубликовать более конкретные инструкции о том, как представить простой пример?
В этой ссылке (https://unpkg.com/[email protected]/README.md ), есть пример фрагмента кода для русалки установка:
```
https://unpkg.com/[email protected]/dist/
```
Я включил этот код, а затем попытался сделать блок-схему в следующем фрагменте кода:
```
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
Но все, что он делает, - это распечатывает этот текст в файле markdown, когда я его просматриваю.
Похоже, что это возможно на основе ReadMe русалки: https://github.com/knsv/mermaid/blob/master/README.md но когда я смотрю на код, это на самом деле изображение блок-схемы, а не рендеринг кода. Так что, возможно, то, о чем я спрашиваю, не так уж и важно. возможно?
Буду признателен за любую помощь!
1 ответ:
К сожалению, GitHub-ароматизированная markdown не поддерживает рендеринг русалочьих графиков. Смотрите этот выпуск для получения дополнительной информации и поиска комфорта у других людей в поисках этой функции;)
Если вы используете VS-код, вы можете использовать это расширение для предварительного просмотра ваших блоков кода mermaid внутри markdown, но обратите внимание, что это не отображается, как только вы поместите его на github. Чтобы включить диаграмму на github, вам придется отрисовать ее в файл, хотя кто-то предложил как-то использовать редактор онлайн-русалки , чтобы отрисовать его и получить URL-адрес к отрисованной версии.
На самом деле, позвольте мне попробовать вставить пример диаграммы из ссылки на предыдущей странице... и-нет. Получаем
Failed to upload image; the format is not supported- ошибку.Поэтому сначала вам нужно будет сохранить его как изображение.
Comments