Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jackton1 authored Mar 18, 2022
1 parent 607cfd5 commit 8e7f931
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,27 @@ Want a cool `Table of Contents` for your markdown and also auto sync changes eac
## Table of Contents
* [Inputs](#inputs)
* [Example](#example)
* [Features](#features)
* [Credits](#credits)
* [Report Bugs](#report-bugs)
* [Contact](#contact)
## Inputs
<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|---------|--------|----------|------------------------|------------------------------------------------------------------------------------------|
| args | string | true | `"--use toc --output"` | [remark cli](https://github.com/unifiedjs/unified-args#cli) options. |
| files | string | true | `"README.md"` | List of input markdown files<br> |
| plugins | string | true | `"remark-toc"` | List of [remarkjs plugins](https://github.com/remarkjs/remark/blob/main/doc/plugins.md). |
| rc\_path | string | false | `".remarkrc.json"` | Remark configuration file |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|---------|--------|----------|--------------------|------------------------------------------------------------------------------------------|
| args | string | true | `"--output"` | [remark cli](https://github.com/unifiedjs/unified-args#cli) options. |
| files | string | true | `"README.md"` | List of input markdown files<br> |
| plugins | string | true | `"remark-toc"` | List of [remarkjs plugins](https://github.com/remarkjs/remark/blob/main/doc/plugins.md). |
| rc\_path | string | false | `".remarkrc.json"` | Remark configuration file |
<!-- AUTO-DOC-INPUT:END -->
Expand Down

0 comments on commit 8e7f931

Please sign in to comment.