bnorth-docdeprecated

document generation and viewer for js, css, es6, react. use dox and compatible for jsdoc.

Usage no npm install needed!

<script type="module">
  import bnorthDoc from 'https://cdn.skypack.dev/bnorth-doc';
</script>

README

bnorth-doc

bnorth-doc 是基于dox 的兼容jsdoc 标准的注释解析，文档生成与文档查看的一站式解决方案。支持js，es6，css，react等。

Why bnorth-doc

  1. jsdoc，react-docgen，cssdoc，esdoc 等格式不兼容, 无法生成统一的文档
  2. bnorth-doc 分为生成器与阅读器两部分，生成器生成json格式数据，阅读器实时读取与显示
  3. 阅读器基于bnorth ，提供良好的页面体验

Getting Started

安装

$ npm i -g bnorth-doc

使用

bnorth-doc [src 默认src] [desc 默认doc]

感谢

感谢github开源社群，感谢dox等优秀项目的帮助和灵感

LICENSE

MIT