steveush / foodoc Goto Github PK

View Code? Open in Web Editor NEW

23.0 23.0 14.0 915 KB

A Bootstrap and Handlebars based JSDoc3 template.

License: GNU General Public License v3.0

JavaScript 89.76% CSS 4.04% HTML 6.20%

foodoc's People

Contributors

Stargazers

Watchers

Forkers

ravikannankr samme prtksxna restjohn mkqavi nothingismagick sitna travist dtex cmidgley ethosprojects rauenzi

foodoc's Issues

TypeError: template.raw.data.insert is not a function

Hello, not sure if it's just me. Following installation steps based on readme and referencing to this tutorial

I am getting following error when running script to generate doc. Appreciate you help and guidance. Thank you

/node_modules/foodoc/template/utils/postProcessor.js:114
        template.raw.data.insert(doclet);
TypeError: template.raw.data.insert is not a function
    at Object.exports.registerReadme (/node_modules/foodoc/template/utils/postProcessor.js:114:20)

template.raw

{
  data: [Function: db] { sort: [Function (anonymous)] },
  opts: {
    _: [ 'cypress/e2e/step_definitions/common_steps.js' ],
    configure: 'conf.json',
    template: '/node_modules/foodoc/template',
    recurse: true,
    destination: './out/',
    encoding: 'utf8',
    readme: undefined
  },
  tutorials: RootTutorial {
    longname: '',
    name: '',
    title: '',
    content: '',
    type: null,
    parent: null,
    children: [],
    _tutorials: {}
  }
}`
```

Any speed-up tips?

I'm using the foodoc template on a project with just over 1000 modules in it and it takes a painfully slow time to build the html, currently just over 1 hour. It doesn't crash, node happily carries on doing its thing and it eventually outputs all the files, but it makes doing test builds quite painful :)

Do you have any ideas on speeding it up? Maybe some node tweaks?

[Enhancement] Add class for home page

Would it be possible to add a class to <body> when we are on the home page? That would simplify the task of adding elements to the home page only.

P.S. I really like foodoc. It's a great template!

remember showAccessFilter selectoin

Good work ! this is one of the best templates I've found and the showAccessFilter is what I needed and surprisingly no other templates support configuring it.

The detail I've found is that it does't remember the user selection - for ex, if the user choose not to show inherited methods then the next class visit should remember this selection. Probably is easy to do it with cookies and javascript - probably i will do it with a external script and share with you - so this is kind of a reminder for me.

THanks again - keep it up.

BTW: I'm maintaining a collection of well known jsdoc3 templates with simple demo and included yours:
https://cancerberosgx.github.io/jsdoc-templates-demo/demo/

Type of event

Hi,

Is it possible to show @type and @property of events like examples in jsdoc documentation?

missing globals.html with typedefs

Given the following file (test.js)

/**
 * Some class
 * @class
 * @global
 */
class A {
    /**
     * some method
     * @param {SomeType} p
     */
    method1(p){
    }
}
/**
 * @typedef {Object} SomeType
 * @property {String} someProp
 */

if you generate documentation with the command jsdoc test.js (no foodoc) everything is OK, in A.html, you have a link to SomeType that goes to global.html#SomeType and it works

if you generate jsdocs with foodoc (command jsdoc test.js -t node_modules/foodoc/template/ then in A.html there is the same link that goes to the same location (global.html#SomeType) but the file globals.html is missing.

The workaround I'm currently doing is generating both documentations so at least I have the globals.html file from the original template, i.e:
jsdoc test.js && jsdoc test.js -t node_modules/foodoc/template/

Sorry I don't have the time to investigate this issue further... Thanks

not support @const

this template not support @const tag

Vue Support

how make this template support jsdoc-vuejs

Take systemName and systemSummary from package.json

I reasonable default for systemName and systemSummary would be field name and description from package.json.

Multi versions

Hello, this project already seems a little abandoned, but it doesn't hurt to try :)

Is there any way for the user to choose to see documentation generated in a previous version? Something like docusaurus does:

(Thanks any help :))

Adding Section

Hi,

I like to add custom sections to the pages and table of contents at the right side. What parts of the template do I need to modify?

Specifically, I would like to add section(s) for vue components: props (90% similar to members)

Thanks,

Does HTML in footer really work?

All-

The documentation defines the footer as

Additional content to place in the footer element of each page before the copyright and default generated by messages. This can contain HTML.

Does this actually work? I've had to luck. The HTML markup appears in the footer. If it does work, could someone point me to an example configuration for it? Maybe I am doing something wrong.

Thanks in advance for your help.

-Josh

Set a theme?

The docs say that foodoc is derived from docStrap, and the config files look quite similar. docStrap supports bootswatch themes using a theme entry. foodoc has the stylesheets and scripts entries. Are they sufficient to change themes? Is there any guidance on how to do it?