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

Fixed ignored plugin option cleanOutputDir #296

Merged
merged 1 commit into from Feb 24, 2022
Merged

Conversation

bra1nDump
Copy link
Contributor

I'm working on adding documentation to cursorless project. We want to serve documentation both from the repository as well as hosted with docusaurus + API generated by typedoc. I'm trying to create a custom read me to serve as API index with key code pointers.

Ideal directory structure

Before running docusaurus-typedoc:

docs/
    document1.md
    api/
        code-pointers.md

After:

docs/
    document1.md
    api/ # out directory option
        code-pointers.md
        index.md # Just a copy of code-pointers.md
        ... Other typedoc documents

Unfortunately right now api directory gets cleaned. I have found this option https://typedoc.org/guides/options/#cleanoutputdir but looks like it's ignored by docusaurus-typedoc. This request addresses this. Only testing I have done is the unit tests which are passing.

@tgreyuk
Copy link
Owner

tgreyuk commented Feb 24, 2022

thanks - makes sense

@tgreyuk tgreyuk merged commit c214012 into tgreyuk:master Feb 24, 2022
@bra1nDump
Copy link
Contributor Author

I bumped the version but it looks like it didn't get auto released to npm https://www.npmjs.com/package/docusaurus-plugin-typedoc. I'm trying to use this in my pull request for this other project, can you please release it if you have time?

@tgreyuk
Copy link
Owner

tgreyuk commented Mar 5, 2022

Sorry - should be released now (in 0.17.2 as i bumped again in error ):)...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants