DEV Community

loading...
Cover image for Get all headings and their target URLs from a Markdown generated page

Get all headings and their target URLs from a Markdown generated page

Christian Heilmann
Open Web guy at Microsoft and long-time JavaScript user
Originally published at christianheilmann.com ・1 min read

When you use Markdown to write your documentation most static page generators will generate IDs for each of the headings in the document to allow you to navigate directly to them.

## Gerbils and other rodents
Enter fullscreen mode Exit fullscreen mode

becomes

<h2 id="gerbils-and-other-rodents">Gerbils and other Rodents</h2>
Enter fullscreen mode Exit fullscreen mode

To go directly there you can then use https://example.com#gerbils-and-other-rodents if you published at example.com.

The other day I was asked to create a list of all the links in the What's new in Devtools 89 document, which is generated from Markdown. The list should be the text of the headline followed by the full URL to get to that part of the document. This was to batch generate some shortURLs from them.

I am pretty sure there are a lot of clever ways to do that by scraping but as I like my browser environment, I just used the Console to do that. Here's the script that you can paste into the Console:

let out = '';
$$(':is(h1,h2,h3,h4,h5,h6)[id]').forEach(elm => {
   out += `${elm.innerText}
${document.location.href}#${elm.id}
` 
});
copy(out);
Enter fullscreen mode Exit fullscreen mode

You can see it in action in the following GIF:

Running the script in the console to get all the heading information

The next step was to store this as a Snippet and next time I just need to run that.

Discussion (0)