Notation

Was ist Notation?

Notation ist ein Tool, mit dem Sie Dokumentation in Markdown schreiben und automatisch in Notion veröffentlichen können. Dadurch können Sie die KI-Funktionen, die Suchfunktion und die Formatierungsoptionen von Notion für Ihre Dokumentation nutzen. Es vereinfacht die Dokumentenverwaltung, indem es sie in der Nähe des Codes hält, und rationalisiert den Veröffentlichungsprozess.

Wie verwende ich Notation?

1. Schreiben Sie Ihre Dokumentation in Markdown.
2. Erstellen Sie eine Notion-Seite, um Ihre Dokumentation zu hosten.
3. Holen Sie sich einen API-Schlüssel von Notion.
4. Platzieren Sie den API-Schlüssel in einer ~/.notation/Notation.toml-Datei.
5. Führen Sie notation ship --src </path/to/you/docs> aus.
6. Zeigen Sie Ihre Dokumentation in Notion mit KI-Suche und -Formatierung an.

Hauptmerkmale:

• Markdown-Unterstützung: Schreiben Sie Dokumentation mit der Standard-Markdown-Syntax.
• Automatische Veröffentlichung: Veröffentlichen Sie Ihre Markdown-Dokumentation einfach in Notion.
• Notion-Integration: Nutzen Sie die KI-, Such- und Formatierungsfunktionen von Notion.
• Flexible Bereitstellung: Bewahren Sie die Dokumentation intern auf, veröffentlichen Sie sie als Notion-Seite oder stellen Sie sie mit Tools wie Super.so als vollständige Website bereit.
• intro.md: Senden Sie Inhalte mit einer intro.md-Datei direkt an die übergeordnete Seite.
• Argumente: Legen Sie den Titel und das Emoji der Seite über CLI-Flags in Ihrer Markdown-Datei fest.

Warum ist Notation wichtig?

Notation behebt mehrere Schwachstellen in der Dokumentenverwaltung:

• Hält die Dokumentation in der Nähe des Codes und fördert so eine bessere Wartung.
• Vermeidet die Notwendigkeit separater Dokumentationsdienste.
• Vereinfacht den Veröffentlichungsprozess.
• Ermöglicht die Nutzung der leistungsstarken Funktionen von Notion für die Dokumentation.

Konfiguration:

Um Notation zu konfigurieren, erstellen Sie eine Notation.toml-Datei neben der Notation-Binärdatei (normalerweise in ~/.notation/).

## ~/.notation/Notation.toml

[notion]
secret = ""
## Dies ist der Titel der Seite, die Ihre neue Dokumentation hosten wird
parent_page = ""

Richten Sie ein Notion-Konto ein, erstellen Sie eine Seite, um Ihre Dokumentation zu hosten, und konfigurieren Sie die Integration, um loszulegen. Detaillierte Anweisungen finden Sie in der vollständigen Dokumentation. Dies erleichtert es jedem, zur Dokumentation beizutragen und sie zu pflegen.

Wo kann ich Notation verwenden?

Notation ist ideal für:

• Softwareprojekte, die eine klare und wartungsfreundliche Dokumentation erfordern.
• Teams, die Notion für das interne Wissensmanagement verwenden.
• Personen, die Markdown zum Schreiben von Dokumentation bevorzugen.

Wie verwende ich Notation am besten?

Um Notation optimal zu nutzen, stellen Sie sicher, dass Ihre Markdown-Dateien gut strukturiert und organisiert sind. Verwenden Sie die Funktion intro.md, um Inhalte direkt zur übergeordneten Seite hinzuzufügen. Nutzen Sie die KI- und Suchfunktionen von Notion, um die Auffindbarkeit zu verbessern.