You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@sneko I experienced a result similar to yours. I'm only showing class names but nothing regarding anything of their properties or methods.
I'm looking for a solution that embeds the documentation into the README.md. Can https://typedoc.org/ do that? I was not able to find anything on it. Thanks!
@jakemayfield I searched a lot and didn't find something convenient.
My conclusion is:
the markdown generated will probably use its own logic of "title 1 (#), title 2 (##)...". Meaning when you embed it in your root markdown file (README.md) it can mess up with your text presentation (depending on your levels of titles and details you have...)
the definition you want to show is often just a resume, not the full details with enum values... when using a generator it's likely it will split definitions across multiple files to make it "digest" inside contexts. Merging the whole among your README.md content would render the thing huge (loosing the main purpose of a clear README.md if you have lot of definitions)
Hi @hipstersmoothie ,
I just tried your lib' but when generating the docs it brings no additional additional for
enum
andclass
definitions. I'm just seeing:Maybe I did something wrong... was it working for you?
Thank you,
EDIT: I switched to https://typedoc.org/ at the end
The text was updated successfully, but these errors were encountered: