typedoc-plugin-markdown
typedoc-plugin-markdown copied to clipboard
typedoc2md
Comments missing from .md
Heyo!
I'm using your plugin to generate .md files, so I can later convert them to asciidoc files, everything works except for getting code comments into .md.
HTML with default theme gets comments with no issues, but it looks like something strips them when using typedoc-plugin-markdown.
What am I missing?
not sure - i couldn't replicate on initial test - will dig into to it to see why this might happen in your use-case.
not sure - i couldn't replicate on initial test - will dig into to it to see why this might happen in your use-case.
If you'll have some time to spare on this issue:
If it helps, I'm trying to markdownify nativescript's docs here: https://github.com/NativeScript/NativeScript
command to build docs is nx run core-api-docs:build
What i should note, you'll need to remove "../../packages/core/**/*.ts" from excludes in /NativeScript/tools/scripts/tsconfig.typedoc.json and it should build just fine
Which versions of typedoc and typedoc-plugin-markdown are used?
Not all versions are compatible with each other due to changes in minor versions of typedoc.
I observed some data missing when trying mutually incompatible versions.
This might also mean some breaking change was not caught up if both versions are most recent.
Which versions of
typedocandtypedoc-plugin-markdownare used? Not all versions are compatible with each other due to changes in minor versions oftypedoc. I observed some data missing when trying mutually incompatible versions. This might also mean some breaking change was not caught up if both versions are most recent.
Damn. You're right, I even forced new typedoc version in package.json but forgot to re-run npm -i, sorry to waste your time, but it helped a lot!
Now it gathers those comments no problemo :3
While you're here, (sorry!) what's the optimal way to fix following markup (or at least avoid writing regex or a script that removes extra free line and move link to the "Defined in" header:
While you're here, (sorry!) what's the optimal way to fix following markup (or at least avoid writing regex or a script that removes extra free line and move link to the "Defined in" header:
Currently working on making the templates easily customisable - not too far off.
@omfgnuts could you please share which versions worked for you?
I've had same issue (documented here) but guessing this may be the problem...
Updating solved for us too.
Facing the same issue. Could you share the specific versions of the two packages that worked for you please?
