Default “Home” text and content for JSDoc

后端 未结 5 1268
眼角桃花
眼角桃花 2020-12-30 23:38

After running a basic JSDoc compile/render from Node.js:

jsdoc file1.js file2.js

I get a well-formatted document using the default template

5条回答
  •  离开以前
    2020-12-31 00:16

    Generate Home page

    Create markdown file README.md

    Generating jsdoc:

    $ jsdoc path/to/js path/to/readme/README.md
    

    To read more about this visit official documentation

    Change 'Home' text

    I don't think this is a proper way to do it but this works.

    If you have jsdoc installed in your project find template file in your working directory, mine was:

    ./node_modules/jsdoc/templates/default/publish.js
    

    Then search for 'Home' with search command and replace with your text, next step is to specify template when generating jsdoc:

     $ jsdoc ./src/scripts/ ./README.md -t node_modules/jsdoc/templates/default/
    

提交回复
热议问题