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

Update docs on internal linking #244

Open
Cwpute opened this issue Aug 7, 2023 · 1 comment
Open

Update docs on internal linking #244

Cwpute opened this issue Aug 7, 2023 · 1 comment

Comments

@Cwpute
Copy link

Cwpute commented Aug 7, 2023

Did a bit of internal linking for my blog, and had a difficult time understanding how it worked.
You have currently two articles talking about it: Anatomy of a post and Navigation. The former has partial information about how it all works, compared to the second, which still lacks some critical information i had to research myself.

The informations that were lacking were about subheaders and internal link formatting, which were both consisely explained here:
image

First, i'd suggest that the section in Anatomy of a post talking about links should provide a shortcut to Navigation for explaination in more details, and second, that you include the above missing informations i had struggle with in Navigation.

Thanks !

@andrei-akopian
Copy link

andrei-akopian commented Jul 19, 2024

As a sidenote in case anybody wants to spread more knowledge:

The #link-to-section actually refer to HTML element ids like the #id syntax in CSS.

If a paragraph has an id you can link to it.

<p id="test"><a href="#test">Test Link<a><p>

Test Link

The internal linking is more HTML than Markdown. Linking to headings requires markdown converter to specifically generate the ids.

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

2 participants