Ossus

Ossus

Ossus ist ein Framework zum Erstellen von Dokumentationsseiten, das sich auf Folgendes konzentriert:

• Ganz einfach : Ossus bringt Sie mit einer Zeile ( create-ossus ) zum Laufen und ermöglicht Ihnen, mit dem Schreiben von Markdowns zu beginnen, ohne sich mit Entwicklungsarbeit herumschlagen zu müssen.
• Anpassbar : Ossus verfügt über vorgefertigte Komponenten für das Layout, die über umfangreiche Themenvariablen verfügen, die Sie überschreiben können. Ossus ist außerdem komponentenbasiert, sodass Sie jede beliebige Layoutkomponente durch Ihre eigene ersetzen können, um die volle Leistung über Ihre Website zu erhalten.
• Skalierbar : Ossus ist für große Projekte konzipiert und verfügt über eine erweiterbare Architektur, damit sich Projekte jeder Größe wie zu Hause fühlen.

Gebaut mit

• Next.js : Ossus basiert auf Next.js und bietet Ihnen leistungsstarkes SSR und statischen Site-Export.
• React : Ossus wurde mit React erstellt, sodass Ihr gesamtes Wissen über die Erstellung von UIs übertragen wird.
• Markdown : Ossus rendert Markdown-Dateien in JSX, damit Ihre Website großartig aussieht, ohne dass Sie jede Seite codieren müssen.

Installation

Ossus besteht aus 3 Paketen:

• ossus
• ossus-components
• ossus-scripts

Alle drei sind als Pakete auf NPM verfügbar: npm install --save ossus ossus-components ossus-scripts ;

Wir stellen auch ein Startskript zur Verfügung, damit Sie Ossus mit einem Befehl einrichten können. Führen Sie einfach npx create-ossus in dem Verzeichnis aus, das Sie verwenden möchten.

Weitere Informationen finden Sie in unserer Dokumentation.

Mitwirken

Wir haben Ossus entwickelt, weil wir kein Framework finden konnten, das perfekt zu unseren Anforderungen bei CDK Global passt. Wir hoffen, dass andere den Nutzen daraus ziehen können, den wir haben, und wir freuen uns über Beiträge aus der Community!

Verhaltenskodex

Wir haben einen Verhaltenskodex verabschiedet, dessen Einhaltung wir von allen Mitwirkenden erwarten. Bitte lesen Sie den Verhaltenskodex, bevor Sie einen Beitrag leisten, damit Sie wissen, was als Teil dieser Community erlaubt ist.

Lizenz

Ossus ist MIT-lizenziert