Skip to content

Commit 184eaa8

Browse files
committed
Add table of contents to readme
Generated using https://github.com/jonschlinkert/markdown-toc ``` npm install --global markdown-toc markdown-toc --bullets=- --maxdepth=5 -i ./README.md ``` The links in the headings had to be removed manually after generating the ToC.
1 parent 2f05f71 commit 184eaa8

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,21 @@
66

77
This action comments on the pull request with a report on the resulting change in memory usage of the [Arduino](https://www.arduino.cc/) sketches compiled by the [`arduino/compile-sketches`](https://github.com/arduino/compile-sketches) action. This should be run from a [scheduled workflow](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#onschedule).
88

9+
## Table of contents
10+
11+
<!-- toc -->
12+
13+
- [Inputs](#inputs)
14+
- [`sketches-reports-source`](#sketches-reports-source)
15+
- [Run from a scheduled workflow](#run-from-a-scheduled-workflow)
16+
- [Run from the same workflow as the `arduino/compile-sketches` action](#run-from-the-same-workflow-as-the-arduinocompile-sketches-action)
17+
- [`github-token`](#github-token)
18+
- [Example usage](#example-usage)
19+
- [Scheduled workflow](#scheduled-workflow)
20+
- [Workflow triggered by `pull_request` event](#workflow-triggered-by-pull_request-event)
21+
22+
<!-- tocstop -->
23+
924
## Inputs
1025

1126
### `sketches-reports-source`

0 commit comments

Comments
 (0)