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

Watch mode doesn't work with typedoc-plugin-markdown #1827

Closed
wilcoxmd opened this issue Dec 22, 2021 · 3 comments
Closed

Watch mode doesn't work with typedoc-plugin-markdown #1827

wilcoxmd opened this issue Dec 22, 2021 · 3 comments
Labels
bug Functionality does not match expectation external Problem lies outside of TypeDoc

Comments

@wilcoxmd
Copy link

wilcoxmd commented Dec 22, 2021

Search terms

watch mode, plugins, typedoc-plugin-markdown

Expected Behavior

When in watch mode, saving a file should regenerate TypeDoc output while respecting any plugins that might transform that output.

Actual Behavior

When using watch mode with typedoc-plugin-markdown, watch mode regenerates HTML instead of markdown files after changes are saved, and deletes the initially output markdown files.

Steps to reproduce the bug

See https://github.com/wilcoxmd/typedoc-watch-plugin-repro

Environment

  • Typedoc version: 0.22.10
  • TypeScript version: 4.5.2
  • Node.js version: 16.13.0
  • OS: macOS Monterey (12.0.1)
@wilcoxmd wilcoxmd added the bug Functionality does not match expectation label Dec 22, 2021
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 3, 2022

This looks like a bug in typedoc-plugin-markdown to me. Instead of adding markdown as a custom theme, it tries to overwrite the default theme (which is not intentionally supported) and doesn't do it consistently before each render, just once on plugin load.

@wilcoxmd
Copy link
Author

wilcoxmd commented Jan 4, 2022

This looks like a bug in typedoc-plugin-markdown to me. Instead of adding markdown as a custom theme, it tries to overwrite the default theme (which is not intentionally supported) and doesn't do it consistently before each render, just once on plugin load.

Thanks for taking a look. I opened a follow up issue in typedoc-plugin-markdown.

@wilcoxmd
Copy link
Author

wilcoxmd commented Jan 5, 2022

The issue was resolved in [email protected]. Thanks again for your help!

@wilcoxmd wilcoxmd closed this as completed Jan 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation external Problem lies outside of TypeDoc
Projects
None yet
Development

No branches or pull requests

2 participants