我正在寻找一个类似于JSDoc的Javascript API文档框架,但会在代码注释中使用易于重构的文本或markdown(而不是html)
奖金:将与Sphinx很好地融合。但是,我不想维护单独的文档,而是根据注释生成API文档。
答案 0 :(得分:6)
我终于找到了最适合任务的JSDuck:
答案 1 :(得分:3)
InvisibleJS支持markdown和其他各种格式。
另请查看docco。
答案 2 :(得分:1)
JSDoc 3现在支持插件降价。您可以通过添加行
来配置降价支持"plugins": [ "plugins/markdown" ],
到您的配置JSON文件。
现在,使用-c conf.json
启动JSDoc将启用markdown支持。
答案 3 :(得分:1)
对于仍在搜索jsdoc-toolkit的markdown插件的用户,请查看以下链接中名为“smartdown”的插件
https://github.com/sproutcore/docs
(关于语法的更多参考:http://guides.sproutcore.com/documentation_guidelines.html)
我通过以下模板(jsdoc-toolkit-rst-template,jsdoc-for-sphinx)使用sphinx尝试了它,并且它完美无缺。