Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 1.18 KB

Advice.md

File metadata and controls

62 lines (39 loc) · 1.18 KB

Advice


It is usually recommendable to use Referenced links as
they can move the clutter - their URLs - into a dedicated
section and making your documentation more readable.



Example

The following paragraph isn't very readable despite
the links not even containing any query parameters.


XYZ comes with a comprehensive **[API](https://organization.github.io/project/docs)** as well as <br>
the ability to integrate with **[Moodle](https://moodle.org/)** / [Canvas](https://its.sdsu.edu/tools/canvas).

It can be turned into:


Comes with a comprehensive **[API]** as well as <br>
the ability to integrate with **[Moodle]** / **[Canvas]**.

+

[Moodle]: https://moodle.org/
[Canvas]: https://its.sdsu.edu/tools/canvas
[API]: https://organization.github.io/project/docs


Placement

You may want to simply group your links into local collections
on a Per-Paragraph basis or instead have a Link Section.