-
Notifications
You must be signed in to change notification settings - Fork 8
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
Use markdown link instead of <a> element #37
Comments
I just created a PR for this (with updated jest tests) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Currently we are busy refactoring the Capacitor Google Maps plugin. One of the improvements is better documentation. The fork (WIP) can be found here: https://github.com/DutchConcepts/capacitor-google-maps/tree/next
I use
docsify
to generate an organized documentation website based on the markdown documentation (can be found in the./docs
folder in that fork). The API reference is generated with this plugin. This works really well, for which I commend you 👏.The generated website (GitHub pages) can be found here.
As can be seen, the links generated by docgen are broken, because they are a
<a>
element instead of a markdown link.It would be solved by changing:
<code><a href="#foobar">FooBar</a></code>
to
<code>[FooBar](#foobar)</code>
The docsify team said the following:
Therefore I hope it can be solved in this plugin. As far as I can see now, I don't think this change does have any drawbacks, so it would make sense to implement it like this. But please do share your opinion about this.
The text was updated successfully, but these errors were encountered: