-
Notifications
You must be signed in to change notification settings - Fork 34
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
Base path is not auto-set to "/" (default) causes ENOENT: no such file or directory #59
Comments
Just try adding |
Shouldn't it already be that since I don't have it defined and that's the default value according to the documentation? |
Right. I'll fix that with the next release. Should I assume setting the |
At first glance that appears to be the case yes, however I should highlight that this isn't consistently reproducible (i.e. refreshing the page also appeared to fix it until the next build run) |
I think that's might be because on the first load the initial page is redirected by the SPA and then you hit reload with the new route. Is that the case? |
Yeah actually it appears that applying |
You're welcome.
How do you mean? Docma already supports grouping multiple JS files documented under the same route and you can have multiples of that too, if that's what you mean. |
Its not a // index.js
import Component1 from './component-1.js'
import Component2 from './component-2.js'
/**
* The primary module
* @module MyLib
*
*/
export default {
Component1,
Component2
}
// component-1.js
/**
* The Component1 class
* @memberof MyLib <- why is this necessary when I'm clearly exporting it in index.js
*/
class Component1 {...}
export default Component1
// component-2.js
/**
* Component2
* @function MyLib#Component2 <- why???
* @param {string} arg - the argument for the function.
* @returns {Object}
*/
function Component2 (arg) {
return {
/**
* @function MyLib#Component2#someFn <- this basically never works correctly.
*/
someFn: function () {...},
/**
* @function MyLib#Componet2#someOtherFn
*/
someOtherFn: function () {...}
}
}
export default Component2 |
:) Unfortunately that's how JSDoc works. If you don't want to use class Component1 { }
function Component2() { }
/**
* MyLib namespace...
* @namespace
*/
const MyLib = {
/**
* Component1
*/
Component1,
/**
* Component2
*/
Component2
};
export default MyLib; |
yeah its just a small nag I have... I actually really hate the namespace feature as it's not overly apparent what a "namespace" is. |
Released with Docma v3.0.0. |
given the following configuration:
images in the left navigation begin to break and terminal errors are logged:
This appears to be related to setting
app.routing
to"path"
as setting it back to "query" seems to resolve the issue.The text was updated successfully, but these errors were encountered: