Notation
Notation - это инструмент, который позволяет вам писать на Markdown и автоматически публиковать в Notion. Он позволяет вам размещать вашу документацию внутренне или как публичный сайт, а также предлагает мощный AI-поиск.
Перечислено в категориях:
Инструменты разработчикаПисьмоGitHub
Описание
Notation — это инструмент, который позволяет вам писать документацию в Markdown и автоматически публиковать ее в Notion. Он бесшовно интегрируется с Notion, позволяя вам управлять вашей документацией вместе с кодом без необходимости в отдельных сервисах. Notation подчеркивает философию дизайна, согласно которой документация живет с кодом, легко доступна и подлежит тем же процессам проверки, что и код.
Как использовать Notation?
Чтобы использовать Notation, напишите вашу документацию в Markdown, создайте страницу в Notion для ее размещения, получите API-ключ от Notion и настройте ваш файл Notation.toml. Наконец, выполните команду 'notation ship src pathtoyoudocs', чтобы увидеть вашу документацию в Notion.
Основные функции Notation:
1️⃣
Писать документацию в Markdown
2️⃣
Автоматически публиковать в Notion
3️⃣
Поддерживает внутреннюю и публичную документацию
4️⃣
Использует AI-поиск и форматирование Notion
5️⃣
Варианты развертывания для внутреннего или публичного доступа
Почему использовать Notation?
| # | Сценарий использования | Статус | |
|---|---|---|---|
| # 1 | Создание внутренней документации для команд | ✅ | |
| # 2 | Публикация публичной документации для продуктов | ✅ | |
| # 3 | Управление документацией вместе с кодом в репозитории | ✅ | |
Разработано Notation?
Notation разработан командой, сосредоточенной на упрощении процесса документирования для разработчиков и недевелоперов. Они придают приоритет интеграции с существующими инструментами и удобному пользовательскому опыту.