Use reference links for type docs

[wopian]

Currently, the generated documentation includes many references to the same String, Object etc. MDN pages. This can get pretty unwieldy when checking the markdown in diff logs for deeply nested parameters:

-   `model` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
-   `params` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
    -   `params.page` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
        -   `params.page.limit` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
        -   `params.page.offset` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
    -   `params.fields` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
    -   `params.filter` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
    -   `params.sort` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
    -   `params.include` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
-   `headers` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**

The same parameter list can be written with reference links, which provides a cleaner diff log and also heavily reduces the documentation's output size (48% reduction with this example)

-   `model` **[String]**
-   `params` **[Object]**
    -   `params.page` **[Object]**
        -   `params.page.limit` **[Number]**
        -   `params.page.offset` **[Number]**
    -   `params.fields` **[Object]**
    -   `params.filter` **[Object]**
    -   `params.sort` **[String]**
    -   `params.include` **[String]**
-   `headers` **[Object]**

[String]:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String
[Object]:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
[Number]:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number

Which would render identically as:

• model String
• params Object
  • params.page Object
    • params.page.limit Number
    • params.page.offset Number
  • params.fields Object
  • params.filter Object
  • params.sort String
  • params.include String
• headers Object

[tmcw]

Sounds like a good idea! I think remark-reference-links would do the trick. Would you be interested in contributing this change?

[wopian]

Currently don't have the time at hand due to uni deadlines coming up 😞