Aller au contenu principal
Version: 2.0.0-alpha.73

Principes de conception

attention

Cette section est en cours de rédaction.

  • Peu de choses à apprendre - Docusaurus devrait être facile à apprendre et à utiliser car l'API est assez petite. La plupart des choses seront toujours réalisables par les utilisateurs, même si cela leur prend plus de code et plus de temps à écrire. Il vaut mieux ne pas avoir d'abstractions que d'avoir des abstractions erronées, et nous ne voulons pas que les utilisateurs aient à bidouiller des abstractions erronées. Conférence obligatoire - Surface minimale de l'API.
  • Intuitif - Les utilisateurs ne se sentiront pas dépassés lorsqu'ils consulteront le répertoire d'un projet Docusaurus ou lorsqu'ils ajouteront de nouvelles fonctionnalités. Il doit être intuitif et facile à développer, en utilisant des approches qui leur sont familières.
  • Architecture en couches - Les séparations des préoccupations entre chaque couche de notre pile (contenu/thème/style) doivent être claires - bien abstraites et modulaires.
  • Des valeurs par défaut raisonnables - Les optimisations et les configurations courantes et populaires en matière de performances sont effectuées pour les utilisateurs, mais ceux-ci ont la possibilité de les remplacer.
  • Pas de verrou de vendeur - Les utilisateurs ne sont pas tenus d'utiliser les plugins par défaut ou CSS, bien qu'ils soient fortement encouragés. Certaines pièces de niveau inférieur au niveau de l'infra comme React Loadable, React Router ne peuvent pas être remplacées parce que nous faisons l'optimisation des performances par défaut sur elles. Mais pas ceux de niveau supérieur, comme le choix des moteurs Markdown, des frameworks CSS, de la méthodologie CSS, qui seront entièrement laissés aux utilisateurs.

Comment fonctionne Docusaurus#

Nous pensons qu'en tant que développeurs, savoir comment une bibliothèque fonctionne est utile pour nous permettre de mieux l'utiliser. C'est pourquoi nous nous efforçons d'expliquer l'architecture et les différentes composants de Docusaurus en espérant que les utilisateurs qui la lisent pourront mieux comprendre cet outil et être encore plus compétents dans son utilisation.