Quel module dois-je utiliser pour générer de la documentation ?

Pour un package node présent sur GITHUB

a marqué ce sujet comme résolu.
Auteur du sujet

Bonjour,

Pour un module node, je souhaite expliquer comment l’utiliser (A) et détailler les prototypes des fonctions publiques (B).

Si c’est possible : J’aimerais pouvoir générer un CSS custom.

Besoin A

Pour expliquer mon module je souhaite faire un dossier ./doc/ avec des fichiers en mardkown où j’explique tout ce qu’il y a à savoir.

Besoin B

Ensuite, comme toute bonne doc qui se respecte j’ai besoin de détailler/lister les fonctions publiques, actuellement (je suis la norme de jsDOC), j’obtiens :

/**
 * create HTTP Server
 *
 * @param   {object}    app     Express app
 * @param   {number}    port    Port number
 */
Http.prototype.createHttpServer = function(app, port) {

Comment dois-je m’y prendre ? Quel choix j’ai si je veux que la mise en prod de la doc soit automatique lorsque je push ma branche master ?

Bon vol,

A.

+0 -0

Cette réponse a aidé l’auteur du sujet

Salut,

Pour la génération de ta documentation MD -> HTML, je te conseille de jeter un oeil à mdbook. L’outil a été conçu avec une API qui permet la gestion d’une collection de noeuds. Y’a peut-être moyen d’ajouter tes CSS avant la fin de la génération.

edit: Sinon il y a apidoc qui supporte la syntaxe dont tu aurais besoin.

Édité par Songbird

The most inflated egos are often the most fragile.

+0 -0
Auteur du sujet

J’ai vu gitbook qui est similaire à mdbook qui semble être conseillé par jsdoc.

@artragis: Normalement il y a jsdoc qui est la solution la plus apte.

En cherchant node documenting recommended, je suis tombé sur The best documentation generator for Node qui présente Docstrap pour styliser le rendu de jsdoc.

Ce que je cherche en faite, c’est que la publication soit automatique lors d’une PR comme pour le zds.

J’avais vu :

Deployment

I use Github Project Pages to deploy my documentation. There are several options here, but I use the gh-pages branch of my project to auto deploy it’s documentation. SideBar: You can also register your documentation site as a sub-domain of js.org. The basic process of deploying my docs is to push the content of the _book/ directory to the gh-pages branch of my project (using git).

Ce passage qui a retenu mon attention, je peux auto-publish sur github.io suite à une PR ? :euh:

+0 -0
Auteur du sujet
image.png
image.png

Une vrai catastrophe jsdoc + docdash, c’est de l’a peu près… :( (J’en suis déjà à 2 PR)

/**
 * Create the App Server with express.
 *
 * @name       AppExpress.createAppServer
 * @param      {eventEmitter}    eventEmitter     eventEmitter
 * @return     {Express}         Returns a new instance of Express.
 */
AppExpress.prototype.createAppServer = function(eventEmitter) {

Je suis obligé de forcer le nom avec AppExpress.createAppServer sinon j’ai AppExpress#createAppServer mais je perd le paramètre… :(

EDIT : Je dois forcer le truc avec : * @function

Édité par anonyme

+0 -0
Connectez-vous pour pouvoir poster un message.
Connexion

Pas encore membre ?

Créez un compte en une minute pour profiter pleinement de toutes les fonctionnalités de Zeste de Savoir. Ici, tout est gratuit et sans publicité.
Créer un compte