web-dev-qa-db-fra.com

Comment incorporer la documentation dans wordpress?

Je construis un site et j'aimerais que ma documentation soit intégrée au site.

Par exemple, si j'utilise JSDoc pour générer de la documentation pour javascript, les fichiers générés automatiquement sont générés. Je peux simplement modifier le modèle pour n'en afficher que le contenu.

Je voudrais générer des pages WordPress pour ces automatiquement.

J'ai un type de message personnalisé qui est un composant, donc je voudrais qu'il fonctionne à peu près comme ceci:

component/component-name/docs/0.0.0/page-name

Je pourrais le faire manuellement, mais il existe de nombreux composants et il serait plus facile de faire en sorte que chaque version intègre automatiquement la documentation.

EDIT

certaines des choses que j'ai à l'esprit:

Idée 1) Ajoutez des arguments supplémentaires à l'URL, ainsi qu'un dossier contenant les documents. Retirez le code HTML du dossier et affichez-le sur la page. L’utiliser essentiellement comme une api de pseudo-repos

  • Avantages : vous n'avez pas à générer de pages, les documents affichent automatiquement le dernier téléchargement.

  • Inconvénients : Impossible de rechercher dans WordPress

Idée 2) Créez un script qui parcourt tous les fichiers d'un dossier docs et génère des pages par programme.

  • Pros : interrogeable dans WordPress

  • Inconvénients : Il faudra probablement supprimer et régénérer des pages en cas de modification, ce qui risque fort de constituer un problème.

Si quelqu'un sait comment WordPress réalise son propre site de codex et peut me diriger vers quelque chose qui peut être à grande échelle mais surtout automatisé, ce serait extrêmement agréable.

pagesautomationdocumentation
1
brianxautumn

WordPress vous permet d'ajouter des onglets d'aide qui apparaissent dans votre tableau de bord et sur chaque page d'administration.

$screen = get_current_screen();

$screen->add_help_tab( array( 

   'id' => $id,            //unique id for the tab
   'title' => $title,      //unique visible title for the tab
   'content' => $content,  //actual help text
   'callback' => $callback //optional function to callback

) );

APIGen ou PHPDoc peut vous aider à créer votre PHP. la documentation de vos DockBlocks et le rendu au format HTML.

Il existe d'autres plugins différents comme WP Help et Documentor qui pourraient vous aider.

Mais c'est presque comme si vous vouliez un guide de style de vie comme this ou this .

Votre meilleur choix est de vous en tenir aux onglets d’aide et de créer des liens vers vos pages générées automatiquement ailleurs - ou de créer vos documents sous forme de livre .

2
jgraup