Skip to content
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

Default value for out option #2195

Closed
DiFuks opened this issue Mar 8, 2023 · 1 comment
Closed

Default value for out option #2195

DiFuks opened this issue Mar 8, 2023 · 1 comment
Labels
enhancement Improved functionality
Milestone

Comments

@DiFuks
Copy link

DiFuks commented Mar 8, 2023

Hello! I am the author of the typedoc-theme-hierarchy library

When the "out" option is not specified, I can't figure out where to copy the custom css and js for my theme

DiFuks/typedoc-theme-hierarchy#17

A possible solution is to return the default value, namely "docs"

await app.generateDocs(project, "./docs");

I can solve this problem by specifying "docs" as the default knowledge on my end. But this can break if the path to the generated folder changes on your end.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Mar 10, 2023

The original reason it was done like this was so that TypeDoc could check if the json/docs options were set, and not generate docs if json was set, since there's an isSet method on options now, seems like a reasonable change.

@Gerrit0 Gerrit0 added help wanted Contributions are especially encouraged good first issue Easier issue for first time contributors labels Mar 10, 2023
@Gerrit0 Gerrit0 added this to the v0.24 milestone Mar 11, 2023
@Gerrit0 Gerrit0 removed help wanted Contributions are especially encouraged good first issue Easier issue for first time contributors labels Mar 12, 2023
@Gerrit0 Gerrit0 mentioned this issue Mar 12, 2023
8 tasks
@Gerrit0 Gerrit0 closed this as completed in fd2493e Apr 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality
Projects
None yet
Development

No branches or pull requests

2 participants