Notation
Notation ist ein Tool, mit dem Sie Markdown schreiben und automatisch in Notion veröffentlichen können. Es ermöglicht Ihnen, Ihre Dokumentation intern oder als öffentliche Website zu hosten und bietet eine leistungsstarke AI-Suchfunktion.
Aufgeführt in Kategorien:
EntwicklerwerkzeugeSchreibenGitHub
Beschreibung
Notation ist ein Tool, mit dem Sie Dokumentationen in Markdown schreiben und automatisch in Notion veröffentlichen können. Es integriert sich nahtlos in Notion und ermöglicht es Ihnen, Ihre Dokumentation zusammen mit Ihrem Code zu verwalten, ohne separate Dienste nutzen zu müssen. Notation betont eine Designphilosophie, bei der Dokumentation mit dem Code lebt, leicht zugänglich ist und denselben Überprüfungsprozessen wie der Code unterliegt.
Wie man benutzt Notation?
Um Notation zu verwenden, schreiben Sie Ihre Dokumentation in Markdown, erstellen Sie eine Notion-Seite, um sie zu hosten, holen Sie sich einen API-Schlüssel von Notion und konfigurieren Sie Ihre Notation.toml-Datei. Führen Sie schließlich den Befehl 'notation ship src pathtoyoudocs' aus, um Ihre Dokumentation in Notion zu sehen.
Hauptmerkmale von Notation:
1️⃣
Dokumentation in Markdown schreiben
2️⃣
Automatisch in Notion veröffentlichen
3️⃣
Unterstützt interne und öffentliche Dokumentation
4️⃣
Nutzen Sie die KI-Suche und -Formatierung von Notion
5️⃣
Bereitstellungsoptionen für internen oder öffentlichen Zugriff
Warum könnte verwendet werden Notation?
| # | Anwendungsfall | Status | |
|---|---|---|---|
| # 1 | Erstellung interner Dokumentationen für Teams | ✅ | |
| # 2 | Veröffentlichung öffentlicher Dokumentationen für Produkte | ✅ | |
| # 3 | Verwaltung von Dokumentationen zusammen mit Code in einem Repository | ✅ | |
Wer hat entwickelt Notation?
Notation wird von einem Team entwickelt, das sich darauf konzentriert, den Dokumentationsprozess für Entwickler und Nicht-Entwickler zu vereinfachen. Sie legen Wert auf die Integration mit bestehenden Tools und eine benutzerfreundliche Erfahrung.