search

apache / cordova

Apache Cordova
https://cordova.apache.org/
615 stars 64 forks source link

[Plugins] Add Table of Contents to README #107

Open janpio opened 5 years ago

janpio commented 5 years ago

When cleaning up the README of cordova-plugin-splashscreen I also added a TOC at the beginning: https://github.com/apache/cordova-plugin-splashscreen

I think all plugin READMEs would benefit from have a table of contents.

janpio commented 5 years ago

Theoretically there are GitHub apps that can automate the process of generating and adding a TOC to a .md file (e.g. https://github.com/apps/toc-me).

Practically I suspect that Apache INFRA will not let these apps do changes on our repositories, so we will probably have to do the changes manually (as I did for the splashscreen plugin) and keep them updated manually as well.

janpio commented 5 years ago

For the splashscreen plugin I used http://ecotrust-canada.github.io/markdown-toc/ and adapted the output a bit (mostly fixing the special character stuff anchors it messes up).