markdowndocumentationgithub-flavored-markdownmultimarkdown

How do I make linked references to sections of the same document using Markdown where the heading title is a sentence with spaces?

While this works

1. [Notifier system requirements](#requirements)

This does not work

1. [Deployment steps](#steps to deployment)

Steps to deployment and requirements are the header/section titles in my README.md file.

Solution

  • Look at the target of the rendered header, either by mousing over it or by inspecting it with your browser's devtools. You should find that the target for your "Steps to deployment" header isn't steps to deployment, but rather steps-to-deployment.

    Update your link like so and it should work:

    1. [Deployment steps](#steps-to-deployment)