Aria Docs

AriaDocs - Modèle de documentation

Ce modèle de documentation riche en fonctionnalités, construit avec Next.js, offre un design élégant et réactif, parfait pour tous les besoins de documentation de votre projet.

Voici toutes les versions du modèle AriaDocs, chacune fabriquée pour des cas d'utilisation spécifiques:

• Docs avancé: un modèle complet offrant des fonctionnalités étendues pour les besoins de documentation approfondis. Parfait pour les projets plus grands qui nécessitent des explications détaillées et des configurations avancées.
  Explorez les documents avancés

• Version Lite: un modèle rationalisé et sans fioritures parfait pour les besoins de documentation simples.
  Explorez la version Lite

• Version avec versioning: une option puissante pour les projets qui nécessitent un suivi de la documentation historique. Gérez plusieurs versions de vos documents sans effort.
  Découvrez la fonction de versioning

• I18N Support Version (WIP): Conçu pour le public international, cette version offrira un support multilingue complet.
  Aperçu du support i18n

Démarrage rapide

Vous pouvez créer un nouveau projet AriaDocs à l'aide de la commande:

 npx create-aria-doc <project-directory>

Sortie attendue

Lorsque vous exécutez la CLI, vous pouvez vous attendre à une sortie similaire à ceci:

 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

Commencer

Tout d'abord, exécutez le serveur de développement:

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

Déployer sur Vercel

La façon la plus simple de déployer votre application Next.js est d'utiliser la plate-forme Vercel à partir des créateurs de next.js.

Consultez notre documentation de déploiement Next.js pour plus de détails.

Caractéristiques clés

Fonctionnalité	Description
Support MDX	Écrivez une documentation interactive avec MDX.
Pages imbriquées	Organisez le contenu dans une structure hiérarchique imbriquée.
Section de blog	Incluez une section de blog dédiée.
Table des matières	TOC généré automatiquement pour une navigation facile.
Pagination	Diviser le contenu sur plusieurs pages.
Syntaxe mise en évidence	Mettez en surbrillance le code pour une meilleure lisibilité.
Ligne de code Soulignement et titres	Mettez en surbrillance des lignes spécifiques avec des titres descriptifs.
Blocs de code interactifs	Affichage de code spécifique à la langue et interactif.
Composants personnalisés	Intégrez les composants personnalisés et réutilisables dans vos documents.
Mode clair et sombre	Basculez entre les thèmes clairs et sombres.
Fonctionnalité de recherche	Trouvez rapidement du contenu avec une recherche intégrée.
Commutateur de code	Basculer entre les langages de code ou les variations.
Copie de code	Copier les blocs de code en un seul clic.
Highlight de l'observateur de TOC	Mettez en surbrillance des sections actives dans le TOC lorsque vous faites défiler.
Génération de sites statique	Générez un site statique et haute performance.
SEO-optimisé	Structuré pour l'indexation optimale du moteur de recherche.

Thèmes supplémentaires