Авторам
Компоненты статей
Примечания, шаги, вкладки, код, таблица, картинка и раскрывающиеся подробности.
Страница показывает компоненты, которыми пишутся статьи. Текст вокруг них — про сам портал, не про продукт.
Примечания
Информация
Информация: нейтральное уточнение, без которого абзац читается неполно.
Совет
Совет: как удобнее сделать то, что и так возможно.
Предупреждение
Предупреждение: легко ошибиться, если пропустить этот абзац.
Ограничение
Ограничение: так сделать нельзя, и обходной путь в эту заметку не входит.
Шаги
Создайте файл в
content/docs.Добавьте его имя в
meta.json.Поставьте ссылку из соседней статьи и прогоните
yarn nx run docs:test.Вкладки
На macOS портал тоже статический: отдайте каталог
apps/docs/out.Код
Блок ниже с названием файла. Кнопка копирования — часть темы Fumadocs.
yarn nx run docs:serveТаблица
| Компонент | Зачем |
|---|---|
Info | Уточнение |
Tip | Совет |
Warning | Риск ошибки |
Limitation | Жёсткая граница |
ReviewNote | Статья перенесена и не перепроверена целиком |
Картинка
Подробности
Ссылка на другую статью
Дальше по оглавлению — начало работы. Якорь этого заголовка копируется с самой строки заголовка.