Search code examples
jsdocjsdoc3

Can I cause JsDoc3 to omit the <footer> tag with the date in it?

JSDoc outputs a date in the footer of each page:

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0</a> on Fri Jan 17 2014 14:30:54 GMT-0800 (PST)
</footer>

So whenever I rebuild my library, all the documentation files look like they've changed to Git. That's not desirable -- I only want to commit these docs when they actually change in content.

Can I cause JsDoc to not output this footer at all?

Solution

  • I have some modest experience with creating jsdoc 3 templates and I've looked at the code to check what you are asking. Here is what I found:

    • <footer> is hardcoded in the default template's layout.tmpl file. By hardcoded, I mean the element itself is not optional.

    • I've not seen any code in the default template's publish.js file that would somehow remove <footer> when processing layout.tmpl.

    So to remove this footer you'd have to use a customized template or do some sort of post-processing on the files generated by jsdoc 3.

    With versions prior to 3.3.0, removing <footer> from the template would mean copying the whole default template and making the change to layout.tmpl. Version 3.3.0, which is currently in alpha, will provide the possibility to basically tell jsdoc 3 to use the default template but with a different layout.tmpl file, which will make customizing templates much easier.