前端-jsduck-快速搭建

桃扇骨 2022-11-15 11:56 167阅读 0赞

最权威的手册就是官网：

[https://github.com/senchalabs/jsduck][https_github.com_senchalabs_jsduck]

里面记录的包括在各个环境的部署安装和使用规范。

看到这个警告，心凉了

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3JhaW55c3ByaW5nNDU0MA_size_16_color_FFFFFF_t_70][]

--------------------

搭建环境 ：win10

第1步：下载windows 安装包

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3JhaW55c3ByaW5nNDU0MA_size_16_color_FFFFFF_t_70 1][]

从第1 个红框中 下载包。第2个红框是部署手册。

安装包截图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3JhaW55c3ByaW5nNDU0MA_size_16_color_FFFFFF_t_70 2][]

部署手册截图：由于我们采用了第一种，所以下面的具体内容可以不看了（那些都是这对第2种的），直接运行生成文档命令。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3JhaW55c3ByaW5nNDU0MA_size_16_color_FFFFFF_t_70 3][]

命令集合：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3JhaW55c3ByaW5nNDU0MA_size_16_color_FFFFFF_t_70 4][]

第2步：写配置文件 jsduck.json

{
        "--title": "XXX文档",
        "--welcome": "welcome.html",
        "--warnings": ["-link", "-no_doc"],
        "--seo": true,
        "--": [
            "./src/canvas"
        ],
        "--output": "./docs",
        "--body-html": [
            "<script type='text/javascript'>",
            "Docs.otherProducts = [",
                "{text: 'Docs 3.0', href: 'http://***/3.0'},",
                "{text: 'Docs 2.0', href: 'http://***/2.0'},",
                "{text: 'Docs 1.0', href: 'http://***/1.0'}",
            "];",
            "</script>"
        ]
    }

第3步：

.\jsduck.exe  --config=d:\jsduck.json

[https_github.com_senchalabs_jsduck]: https://github.com/senchalabs/jsduck
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3JhaW55c3ByaW5nNDU0MA_size_16_color_FFFFFF_t_70]: /images/20221022/c4b4a1486a9840d68f81a158d9f02270.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3JhaW55c3ByaW5nNDU0MA_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20210401100010180.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3JhaW55c3ByaW5nNDU0MA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3JhaW55c3ByaW5nNDU0MA_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20210401100154311.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3JhaW55c3ByaW5nNDU0MA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3JhaW55c3ByaW5nNDU0MA_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20210401100344428.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3JhaW55c3ByaW5nNDU0MA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3JhaW55c3ByaW5nNDU0MA_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20210401101037712.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3JhaW55c3ByaW5nNDU0MA==,size_16,color_FFFFFF,t_70