Aria Docs

Ariadocs - Dokumentationsvorlage

Diese mit Next.js erstellte Funktionsvorlage für Funktionen bietet ein elegantes und reaktionsschnelles Design, perfekt für alle Ihre Projektdokumentationsanforderungen.

Hier sind alle Versionen der Ariadocs -Vorlage, die jeweils für bestimmte Anwendungsfälle hergestellt wurden:

• Erweiterte Dokumente: Eine umfassende Vorlage, die umfangreiche Funktionen für eingehende Dokumentationsanforderungen bietet. Perfekt für größere Projekte, die detaillierte Erklärungen und erweiterte Konfigurationen erfordern.
  Erforschen Sie die fortgeschrittenen Dokumente

• Lite-Version: Eine optimierte Schablone ohne Frist, perfekt für einfache Dokumentationsanforderungen.
  Erkunden Sie die Lite -Version

• Version mit Versioning: Eine leistungsstarke Option für Projekte, die eine historische Dokumentationsverfolgung erfordern. Verwalten Sie mühelos mehrere Versionen Ihrer Dokumente.
  Schauen Sie sich die Versionsfunktion an

• I18N Support Version (WIP): Diese Version für internationale Zielgruppen bietet umfassende mehrsprachige Unterstützung.
  Vorschau der I18N -Unterstützung

Schneller Start

Sie können ein neues Ariadocs -Projekt mit dem Befehl erstellen:

 npx create-aria-doc <project-directory>

Erwartete Ausgabe

Wenn Sie die CLI ausführen, können Sie eine ähnliche Ausgabe erwarten:

 Creating a new Ariadocs project in /path/to/your/project from the master branch...
Cloning Master (Full Documentation)...
Ariadocs project successfully created in /path/to/your/project!

Next steps:
1. Navigate to your project directory:
   cd <project-directory>
2. Install dependencies:
   // To support React 19, package maintainers will need to test and update their packages to include React 19 as a peer dependency. This is already in progress.
   npm install --force 
3. Start the development server:
   npm run dev

Erste Schritte

Führen Sie zunächst den Entwicklungsserver aus:

 npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Auf Vercel bereitstellen

Der einfachste Weg, um Ihre Next.js -App bereitzustellen, besteht darin, die Vercel -Plattform von den Erstellern von Next.js. zu verwenden.

Weitere Informationen finden Sie in unserer Next.JS -Bereitstellungsdokumentation.

Schlüsselmerkmale

Besonderheit	Beschreibung
MDX -Unterstützung	Schreiben Sie interaktive Dokumentation mit MDX.
Verschachtelte Seiten	Inhalte in einer verschachtelten, hierarchischen Struktur organisieren.
Blog -Abschnitt	Fügen Sie einen dedizierten Blog -Abschnitt hinzu.
Inhaltsverzeichnis	Automatisch generierter TOC für einfache Navigation.
Pagination	Inhalt auf mehrere Seiten teilen.
Syntax -Hervorhebung	Markieren Sie den Code für eine bessere Lesbarkeit.
Codelinien -Hervorhebung und Titel	Markieren Sie bestimmte Zeilen mit beschreibenden Titeln.
Interaktive Codeblöcke	Sprachspezifische und interaktive Codeanzeige.
Benutzerdefinierte Komponenten	Betten Sie benutzerdefinierte, wiederverwendbare Komponenten in Ihre Dokumente ein.
Hell & Dark -Modus	Zwischen hellen und dunklen Themen wechseln.
Suchfunktionalität	Finden Sie schnell Inhalte mit einer integrierten Suche.
Code -Switcher	Wechseln Sie zwischen Codesprachen oder Variationen.
Codekopie	Kopieren Sie Codeblöcke mit einem einzigen Klick.
TOC Observer Highlight	Markieren Sie aktive Abschnitte im TOC, während Sie scrollen.
Statische Stättengenerierung	Generieren Sie eine statische Hochleistungsstelle.
SEO-optimiert	Für eine optimale Suchmaschinenindizierung strukturiert.

Zusätzliche Themen