How to generate a Table of Contents (ToC) on a rendered Github Pages README.md?

Question

Is there a way to generate a ToC on a rendered README.md hosted on Github Pages that doesn't require the use of local Jekyll plugins to generate it prior to uploading it to Github Pages?

score 13 · Accepted Answer · answered Jan 17 '19 at 20:16

13

According to this post, all you have to do is add {:toc} in your markdown page at the place you want a table of contents.

answered Jan 17 '19 at 20:16

Adrian J. Moreno

14,350
1
37
44

3

Thanks! Actually, you need to add `* TOC {:toc}` once you added `markdown: kramdown` to your `_config.yml`. – orschiro Jan 17 '19 at 21:11
3

Still not working. Can you link your repo where it works? – PeterT Mar 09 '21 at 17:33
1

We need to insert a new line to let TOC be rendered `* Placeholder for Table of Content (Must not be removed) {:toc}` – Sunfarm Aug 03 '21 at 17:28

Sush · Answer 2 · 2022-05-24T22:11:24.297

-1

You have to wrap the ToC contents between TOC and /TOC fields in the README.md file.

edited May 24 '22 at 22:11

answered Apr 10 '21 at 21:28

Sush

1
2

404 on https://github.com/write2sushma/TaxiDataPipeLine – Titi Wangsa bin Damhore May 22 '22 at 14:38

How to generate a Table of Contents (ToC) on a rendered Github Pages README.md?

2 Answers2