2

I tried to generate a source code documentation of a JavaScript file. For this I also wrote a README using markdown syntax. I run:

jsdoc -R client.md -d client client.js

The command generates the HTML documentation. In the generated output the following titles are defined:

<title>JSDoc: Home</title>
<h1 class="page-title">Home</h1>

How can I change Home and JSDoc: Home to something useful like the name of my program?

I tried already to write a configuration file as suggested here, but that seems to work only for tutorials and not for READMEs.

Community
  • 1
  • 1
ceving
  • 21,900
  • 13
  • 104
  • 178

1 Answers1

3

Right now it is hard coded in the default template. My pull request makes it configurable. Putting it in the configuration file works with the change.

{
  "title": "My title"
}
ceving
  • 21,900
  • 13
  • 104
  • 178
  • Great idea with the PR, why does it take 4 years to implement? – crs1138 Apr 06 '20 at 06:15
  • 1
    @crs1138 Probably wrong place to ask. – ceving Apr 06 '20 at 09:23
  • @ceving actually I want to change `JSDoc` to the actual project name, so that instead of `JSDoc: Home` it could be `My Project: Home` and then other pages will have `My Project: Other` etc. Is that what your PR does? Seems like it only changes the home page title, like `JSDoc: My title` ‍♂️ – ADTC Oct 27 '21 at 18:48