Notation
Notation est un outil qui vous permet d'écrire en Markdown et de publier automatiquement dans Notion. Il vous permet d'héberger votre documentation en interne ou en tant que site Web public, tout en offrant une recherche AI puissante.
Listé dans les catégories:
Outils de développementÉcritureGitHub
Description
Notation est un outil qui vous permet d'écrire de la documentation en Markdown et de la publier automatiquement sur Notion. Il s'intègre parfaitement à Notion, vous permettant de gérer votre documentation aux côtés de votre code sans avoir besoin de services séparés. Notation met l'accent sur une philosophie de conception où la documentation vit avec le code, est facilement accessible et est soumise aux mêmes processus de révision que le code.
Comment utiliser Notation?
Pour utiliser Notation, écrivez votre documentation en Markdown, créez une page Notion pour l'héberger, récupérez une clé API de Notion et configurez votre fichier Notation.toml. Enfin, exécutez la commande 'notation ship src pathtoyoudocs' pour voir votre documentation dans Notion.
Fonctionnalités principales de Notation:
1️⃣
Écrire de la documentation en Markdown
2️⃣
Publier automatiquement sur Notion
3️⃣
Prend en charge la documentation interne et publique
4️⃣
Utilise la recherche et le formatage AI de Notion
5️⃣
Options de déploiement pour un accès interne ou public
Pourquoi pourrait-il être utilisé Notation?
| # | Cas d'utilisation | Statut | |
|---|---|---|---|
| # 1 | Créer une documentation interne pour les équipes | ✅ | |
| # 2 | Publier une documentation publique pour les produits | ✅ | |
| # 3 | Gérer la documentation aux côtés du code dans un dépôt | ✅ | |
Développé par Notation?
Notation est développé par une équipe axée sur la simplification du processus de documentation pour les développeurs et les non-développeurs. Ils priorisent l'intégration avec les outils existants et une expérience utilisateur conviviale.