ionic-team / ionic-team/capacitor-docgen

Use markdown link instead of <a> element

Open
#37 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
13
Forks
11
PR merge metrics
No merged PRs in 30d

Description

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](https://dutchconcepts.github.io/capacitor-google-maps/#/api).

As can be seen, the links generated by docgen are broken, because they are a `` element instead of a markdown link.

It would be solved by changing:
```
FooBar```
to
```[FooBar](#foobar)```

The docsify team said the following:

> You need generate markdown syntax. Such as
>
> ```[MyClass](#MyClass)```
>
> It will not be compiled if it is HTML.

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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.