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

Favor Reference Style Links in our Markdown files #110

Open
kernelsam opened this issue Feb 15, 2024 · 0 comments
Open

Favor Reference Style Links in our Markdown files #110

kernelsam opened this issue Feb 15, 2024 · 0 comments
Assignees

Comments

@kernelsam
Copy link
Contributor

kernelsam commented Feb 15, 2024

Problem

See: https://www.markdownguide.org/basic-syntax/#reference-style-links

Currently most of our markdown is using inline links and repeating the same link multiple times which has caused a lot of extra work during migration.
This can be mitigated by using reference links. See implementation here:

Do note from the above example that when viewing the github preview of the markdown, the reference links will not be displayed at the bottom of the file: https://github.com/senzing-garage/knowledge-base/blob/main/HOWTO/create-senzing-github-repository.md

Standards:

  • The [label] should be descriptive of what the link references.
  • All link references should be at the very bottom of the markdown file.
  • If the link is pointing to a file within the same repository it should instead be using a relative link
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant