Skip to content
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

Convert markdown inline links to reference style links #1100

Closed
spwoodcock opened this issue Jan 15, 2024 · 3 comments · Fixed by #1116
Closed

Convert markdown inline links to reference style links #1100

spwoodcock opened this issue Jan 15, 2024 · 3 comments · Fixed by #1116
Labels
docs Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@spwoodcock
Copy link
Member

spwoodcock commented Jan 15, 2024

Problem

We use the inline style of markdown links for all .md files:
[link here](https://website.com/some/link)

This creates linting errors due to line length, and is also not the preferred approach with markdown.

Solution

Use reference style links in all markdown files:

[link here][1]

... end of file
[1]: https://website.com/some/link

The reference is not limited by line length.

Task

Update all .md files under docs to use references for links and images.

An example of the correct format can be found here: https://github.com/hotosm/fmtm/blob/development/docs/index.md

Related Tasks

A smaller chunk of #921

@spwoodcock spwoodcock added docs Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jan 15, 2024
@cordovez
Copy link
Contributor

Hi all,
I would like to have a crack at this if you still need it done.

@spwoodcock
Copy link
Member Author

Hi @cordovez !

It would be a huge help if you could - thanks so much 🙏

@cordovez
Copy link
Contributor

done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants