kpn / kpn-style

Reusable (style) packages for anyone working on front-end for KPN.
https://style.kpn.com
MIT License
17 stars 4 forks source link

Add a table of contents to all pages, similar to Wikipedia #27

Open coenkoopmans opened 4 years ago

coenkoopmans commented 4 years ago

Description

On Wikipedia, almost every page has a table of contents, like this one: https://en.wikipedia.org/wiki/JavaScript

The strong points of a table of contents are:

This is perfect for a reference work, such as our documentation. For these reasons, we should build a table of contents of our own that is easy to integrate into the MD files (almost all of them, context dependent). That means finding a way that is easily reusable and wards against errors when consuming the code in the MD files.

Acceptance criteria

jordybulten commented 4 years ago

As a POC we updated the App Layout component already. For now we should update the Contributing page to explain how to create a page with a TOC. See #56