Notation Как использовать
Notation — это инструмент, который автоматически публикует документацию в формате Markdown в Notion, обеспечивая бесшовную интеграцию документов с репозиториями кода.
Посмотреть большеДополнительная информация
Как использовать Notation
Установить Notation: Выполните команду установки: curl -sSL https://github.com/kristian1108/notation/raw/master/install.sh | bash
Создать аккаунт в Notion: Зарегистрируйтесь в Notion по адресу https://www.notion.so/, если у вас ещё нет аккаунта
Создать родительскую страницу в Notion: Создайте новую страницу в Notion, которая будет размещать вашу документацию
Создать интеграцию в Notion: Перейдите в Настройки & Участники > Подключения > Разработка или управление интеграциями. Создайте новую внутреннюю интеграцию и скопируйте секретный ключ
Настроить Notation: Создайте файл Notation.toml в ~/.notation/ с вашим секретом Notion и названием родительской страницы
Подключить интеграцию к странице: На вашей родительской странице Notion перейдите в ... > Подключения и добавьте вашу новую интеграцию
Написать документацию: Напишите вашу документацию в формате Markdown
Опубликовать документацию: Выполните команду: notation ship --src </path/to/your/docs>, чтобы опубликовать вашу документацию в Notion
Просмотреть в Notion: Проверьте вашу страницу Notion, чтобы увидеть опубликованную документацию с форматированием, поиском и функциями ИИ
Часто задаваемые вопросы о Notation
Notation - это инструмент, который позволяет вам писать документацию в формате Markdown и автоматически публиковать её в Notion. Он позволяет сохранять документацию вместе с репозиторием кода, используя при этом функции Notion, такие как поиск с помощью ИИ и форматирование.
Показать больше