arduino/library-registry
1
0
Fork 0
mirror of https://github.com/arduino/library-registry.git synced 2025-07-31 01:03:09 +03:00
Code Activity

Add table of contents to documentation

Browse Source 
It will be helpful to the reader to be able to get an overview of the documentation content and quickly navigate to the
section of interest.

The table of contents are automatically generated using the markdown-toc tool.

Because it can be easy to forget to update the table of contents when the documentation content is changed, I have added
a CI workflow to check for missed updates to readme ToC. On every push or pull request that affects the repository's
documentation, it will check whether the table of contents matches the content.
This commit is contained in:
per1234
2021-04-09 07:55:39 -07:00
parent 2d79e0e492
commit 4b40e08342
3 changed files with 100 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -3,6 +3,21 @@
This repository contains the list of libraries in the
[Arduino Library Manager](https://www.arduino.cc/en/guide/libraries#toc3) index.
## Table of Contents
<!-- toc -->
- [Frequently asked questions](#frequently-asked-questions)
- [Adding a library to Library Manager](#adding-a-library-to-library-manager)
- [Instructions](#instructions)
- [If the problem is with the pull request:](#if-the-problem-is-with-the-pull-request)
- [If the problem is with the library:](#if-the-problem-is-with-the-library)
- [Changing the URL of a library already in Library Manager](#changing-the-url-of-a-library-already-in-library-manager)
- [Removing the URL of a library already in Library Manager](#removing-the-url-of-a-library-already-in-library-manager)
- [Report a problem with Library Manager](#report-a-problem-with-library-manager)
<!-- tocstop -->
## Frequently asked questions
For more information about Arduino Library Manager and how the index is maintained, please see [the FAQ](FAQ.md).