Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kdheepak authored Mar 28, 2024
1 parent 58e1bff commit 6b511c3
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ vimdoc.

# Usage

### Using Github Actions
### Generating vimdoc using GitHub Actions

Create an empty doc file:

Expand Down Expand Up @@ -119,7 +119,7 @@ For an example of how this is used, see one of the following workflows:
Or see any of the packages here that depend on this action:
<https://github.com/kdheepak/panvimdoc/network/dependents>

### Generating Web Documentation
### Generating HTML using GitHub Actions

If you are interested in making your vim plugin documentation available as a HTML page, check out
[.github/workflows/docs.yml](./.github/workflows/docs.yml) file.
Expand Down Expand Up @@ -160,7 +160,7 @@ jobs:
folder: public
```

### Using pre-commit
### Using pre-commit locally

[pre-commit](https://pre-commit.com/) lets you easily install and manage pre-commit hooks locally.

Expand Down Expand Up @@ -199,7 +199,7 @@ To change the input file, modify the `files` field of the hook and supply the co
- <your-input-file.md>
```

### Using it manually
### Using it manually locally

The `./panvimdoc.sh` script runs `pandoc` along with all the filters and custom output writer.

Expand Down

0 comments on commit 6b511c3

Please sign in to comment.