org-roam / org-roam-ui

A graphical frontend for exploring your org-roam Zettelkasten
GNU General Public License v3.0
1.98k stars 109 forks source link

[ENH] README.MD link to package.el doesn't work #219

Open paxsali opened 2 years ago

paxsali commented 2 years ago

The link the first section of the installation instructions with package.el doesn't work in the main README.md.

I clicked all the links to see if I find other non-working ones. It appears only package.el is affected.

**Table of Contents**

- [Changelog](#changelog)
- [Installation](#installation)
  - [Using package.el](#package.el)   #  <<------ this link doesn't work for some reason
  - [Doom](#doom)
  - [straight/use-package](#straightuse-package)
- [Usage](#usage)
- [Disclaimers ‼](#disclaimers-)
- [FAQ 🗨](#faq-)
- [Features ✨](#features-)
  - [Planned features](#planned-features)
- [Supporting org-roam-ui](#supporting-org-roam-ui)
  - [Feedback](#feedback)
  - [Contribute 💪](#contribute-)
     - [Hacktoberfest](#hacktoberfest)
  - [Donate](#donate)
    - [Sponsors](#sponsors)
paxsali commented 1 year ago

I found the issue.

The link to the heading Using package.el is (when doing mouse-over): https://github.com/org-roam/org-roam-ui#packageel

However, the issue is that the link inside the README.MD is this: https://github.com/org-roam/org-roam-ui#package.el

Notice the difference. The non-working link contains a dot, the self-generated mouse-over link doesn't.

You only need to update your README.MD.