Ossus

Ossus

Ossus est un framework pour la création de sites de documentation qui se concentre sur :

• Simple : Ossus vous permet d'être opérationnel avec une seule ligne ( create-ossus ) et vous permet de commencer à écrire du markdown sans avoir à vous soucier du travail de développement.
• Personnalisable : Ossus est livré avec des composants prédéfinis pour la mise en page qui comportent de nombreuses variables de thème que vous pouvez remplacer. Ossus est également basé sur des composants, vous pouvez donc remplacer n'importe lequel des composants de mise en page par le vôtre pour obtenir toute la puissance sur votre site.
• Évolutif : Ossus est conçu autour de grands projets et possède une architecture extensible pour permettre aux projets de toute taille de se sentir comme chez eux.

Construit avec

• Next.js : Ossus est construit sur Next.js pour vous offrir une puissante exportation SSR et de sites statiques.
• React : Ossus est construit avec React donc toutes vos connaissances sur la création de transferts d'interface utilisateur.
• Markdown : Ossus restitue les fichiers markdown en JSX afin que votre site puisse avoir fière allure sans que vous ayez à coder chaque page.

Installation

Ossus est composé de 3 packages :

• ossus
• ossus-components
• ossus-scripts

Tous les trois sont disponibles sous forme de packages sur NPM : npm install --save ossus ossus-components ossus-scripts ;

Nous fournissons également un script de démarrage afin que vous puissiez configurer Ossus en une seule commande, exécutez simplement npx create-ossus dans le répertoire que vous souhaitez utiliser.

Plus d’informations peuvent être trouvées sur notre documentation.

Contribuer

Nous avons créé Ossus parce que nous ne parvenions pas à trouver un framework parfaitement adapté à nos besoins chez CDK Global. Nous espérons que d’autres pourront en tirer la valeur que nous avons, et nous apprécions les contributions de la communauté !

Code de conduite

Nous avons adopté un code de conduite auquel nous attendons de tous les contributeurs qu'ils adhèrent. Veuillez lire le code de conduite avant de contribuer afin de savoir ce qui est autorisé en tant que membre de cette communauté.

Licence

Ossus est licencié au MIT