The Wayback Machine - https://web.archive.org/web/20200527065927/https://github.com/documentationjs/documentation/issues/1302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

NODE_API.md does not to indicate support for .yml configuration, but I can? #1302

Open

lukwallace opened this issue Jan 14, 2020 · 1 comment

lukwallace commented Jan 14, 2020 •

edited

Was reading the the docs, and wanted to make use of the configuration mentioned here, with the nodejs apis.

But, I couldn't find any mention of it in the nodejs api docs. Had to do some digging into the source to see what was truly available (it is).

Posting this issue here; hoping it might save someone the time in the future, if they're looking to do the same:

var documentation = require('documentation');
documentation.build('src/**', { config: 'documentation.yml' }).then((res) => {

});

^ This seemed to have worked for me.

What version of documentation.js are you using?: 12.1.4
How are you running documentation.js (on the CLI, Node.js API, Grunt, other?): Node.js API

Member

tmcw commented Jan 17, 2020

Indeed, that's true - what's needed is to add config as an argument in the build method’s jsdoc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

You can’t perform that action at this time.