dask / dask-blog

Dask development blog

Home Page:https://blog.dask.org/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

What syntax do I need for links in a table of contents?

GenevieveBuckley opened this issue · comments

Clicking the links in the table of contents in this blogpost doesn't take you to the corresponding section of the post, but it does work if you do it here.

Did I get the syntax for this wrong? Or is jekyll somehow losing these markers when it renders things?

This is what I used as my markdown syntax:

## Contents
* [Background](#Background)
* [What we learned](#What-we-learned)
    * [From Dask users](#From-Dask-users)
    * [From other software libraries](#From-other-software-libraries)
* [Opportunities we see](#Opportunities-we-see)
* [Strategic plan](#strategic-plan)
* [Limitations](#Limitations)
* [Methods](#Methods)
* ```

Does un-capitalizing the leading letters help?

- * [Background](#Background)
+ * [Background](#background)

Entering https://blog.dask.org/2021/03/04/the-life-science-community#background into my URL bar navigates to the "Background" header for me.

Whoops – I made some typos in #90 (comment), and have fixed them now.

Hey, I think that's the fix! Thank you @stsievert

I think this is the list of rules for internal hyperlinks with jekyll:

  • Replace all spaces with hyphens
  • Make all letters lowercase
  • Remove punctuation characters (like colons)