Skip to content

Commit

Permalink
Update docgen docs so they arent picked up by the pre-commit hook
Browse files Browse the repository at this point in the history
  • Loading branch information
oandregal committed Mar 24, 2020
1 parent 77dd061 commit 4119f47
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions packages/docgen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ This command will generate a file named `entry-point-api.md` containing all the
* **--output** `(String)`: Output file that will contain the API documentation.
* **--to-section** `(String)`: Append generated documentation to this section in the Markdown output. To be used by the default Markdown formatter. Depends on `--output` and bypasses the custom `--formatter` passed, if any.
* **--to-token**: Embed generated documentation within the start and end tokens in the Markdown output. To be used by the default Markdown formatter.Depends on `--output` and bypasses the custom `--formatter` passed, if any.
* Start token: <code>&lt;!-- START TOKEN(Autogenerated API docs) --></code>
* End token: `<!-- END TOKEN(Autogenerated API docs) -->`
* **--use-token** `(String)`: This options allows you to customize the string between the tokens. For example, `--use-token my-api` will look up for the start token <code>&lt;!-- START TOKEN(my-api) --></code> and the end token `<!-- END TOKEN(my-api) -->`. Depends on `--to-token`.
* Start token: <code>&lt;!-- START TOKEN(Autogenerated API docs) --&gt;</code>
* End token: <code>&lt;!-- END TOKEN(Autogenerated API docs) --&gt;</code>
* **--use-token** `(String)`: This options allows you to customize the string between the tokens. For example, `--use-token my-api` will look up for the start token <code>&lt;!-- START TOKEN(my-api) --&gt;</code> and the end token <code>&lt;!-- END TOKEN(my-api) --&gt;</code>. Depends on `--to-token`.
* **--debug**: Run in debug mode, which outputs some intermediate files useful for debugging.

## Examples
Expand Down

0 comments on commit 4119f47

Please sign in to comment.