Перейти до основного вмісту

Markdown

Загальні відомості

Markdown - це простий спосіб форматування тексту, полегшена мова розмітки даних, який чудово виглядає на будь-якому пристрої. Він не робить нічого такого, як зміна розміру, кольору або типу шрифту – лише найнеобхідніше, використовуючи символи клавіатури, які ви вже знаєте.

Особливості у генераторах документації

Docusaurus

Використовує MDX як механізм синтаксичного аналізу, який може робити набагато більше, ніж просто аналізувати стандартний синтаксис Markdown, наприклад, відображати компоненти React усередині ваших документів.

Детальніше — docusaurus.io

Material for MkDocs

Material для MkDocs містить безліч чудових функцій, які перетворюють технічне написання на задоволення. Тут — squidfunk.github.io пояснюється, як налаштувати сторінку, і демонструються всі зразки, які можна використовувати безпосередньо з файлів Markdown.

DocFX

DocFx поддерживает совместимый с CommonMark Markdown — commonmark.org, проанализированный с помощью механизма синтаксического анализа Markdig — github.com/xoofx.

Детальніше — dotnet.github.io