ngdoc-parser update - Githubissues

douglasduteil / angular-utility-belt

My non-lethal angular gadgets

http://douglasduteil.github.io/angular-utility-belt

MIT License

3 stars 1 forks source link

ngdoc-parser update #10

Open douglasduteil opened 10 years ago

douglasduteil commented 10 years ago

NGDOC-PARSER UDATE BOYS !

I patched my parser to be ready to generate our API section in the README (Following #7).

Little changelog here :

remove unnecessary key, value keys in comments params. Direct use of the value of the value key... (the actual parsing result)
for each comments the params are converted to an array of params.
fix wrong end of line in multi line descriptions.

Breaking feature :

The transformation replace the content of the given file now. The output file is expected to be a pure JSON file.

Demo new demo here https://gist.github.com/douglasduteil/5bff06c0fc3be08f19b6

I'm thinking of externalizing it to a separate repo like ngdoc-to-markdown. It will almost content this with the options externalized.

What you think @mgcrea @revolunet

revolunet commented 10 years ago

ok génial donc on a deux tools :

ngDocParser pour récupérer le JSON
et ngdoc-to-markdown pour le markdown direct, c'est beau :+1:

Je crois que la prochaine étape pour se synchro serait de se refaire une petite réu pour voir notre roadmap et se répartir les tâches, perso j'ai besoin d'être guidé sur coup là :) Je vous propose un soir de la semaine prochaine, genre vers 18h mercredi ?

mgcrea commented 10 years ago

@douglasduteil je suis en phase aussi pour modulariser un maximum. Il faut qu'on arrive à un truc lean.

Sinon pourquoi pas faire un ngdoc-formatter plus générique, basé sur nunjucks, pour générer au choix de l'HTML ou du markdown via des templates prédéfinis, ou autre chose en passant un template nunjucks en param?

douglasduteil commented 10 years ago

@revolunet K pour moi mercredi prochain.

@mgcrea Wa bonne idée ! :+1: Go pour ngdoc-formatter je fais ça ce soir rapide ;)

douglasduteil commented 10 years ago

\cc @revolunet @mgcrea

All done boys :)

mgcrea commented 10 years ago

Congratz, hâte de faire joujou avec! Je vais essayer de me trouver du temps cette semaine pour arriver à assembler ce qui reste en cours, pour avoir un premier proto & qu'on puisse avancer vers une release!

revolunet commented 10 years ago

naïsse !

mgcrea commented 10 years ago

Bon bah un peu la loose cette dernière semaine, pas eu le temps d'avancer dessus + mariage de vendredi à dimanche hors de Paris. This week hopefully ;-).