Skip to content

Commit

Permalink
headers
Browse files Browse the repository at this point in the history
  • Loading branch information
npalm committed Feb 18, 2024
1 parent c890e5b commit d4032e2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
- name: Update docs
uses: './'
with:
tocLevel: 2
tocLevel: 1

- name: Update dist in the repository
if: github.ref != 'refs/heads/main'
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
<a href="https://github.com/npalm/action-docs-action/actions"><img alt="action-docs-action status" src="https://github.com/npalm/action-docs-action/actions/workflows/ci.yml/badge.svg"></a>
</p>

<!-- action-docs-header action="action.yml" -->
<!-- action-docs-header action="action.yml" -->

This action wraps [action-docs](https://github.com/npalm/action-docs) to update action documentation. By default the action will update `README.md` based on the the `action.yml`. See the parameters for changing the defaults.


## Usages

The action will update you readme by replacing html comment tags. Add one of more tags based on the following template to your repo: `<!-- action-docs-(header | description | inputs | outputs | runs -->` to add the corresponding section.
Expand All @@ -26,7 +27,7 @@ The action will not commit any change, to ensure the changes are persisted you c
<!-- action-docs-inputs action="action.yml" -->
### Inputs
## Inputs
| name | description | required | default |
| --- | --- | --- | --- |
Expand All @@ -39,7 +40,7 @@ The action will not commit any change, to ensure the changes are persisted you c


<!-- action-docs-runs action="action.yml" -->
### Runs
## Runs

This action is a `node20` action.
<!-- action-docs-runs action="action.yml" -->
Expand Down

0 comments on commit d4032e2

Please sign in to comment.