From 6b511c36812c69e490c81dcc6ff77a6c08c03cf4 Mon Sep 17 00:00:00 2001 From: Dheepak Krishnamurthy Date: Wed, 27 Mar 2024 20:55:41 -0400 Subject: [PATCH] docs: Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7a88172..e3cef0d 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ vimdoc. # Usage -### Using Github Actions +### Generating vimdoc using GitHub Actions Create an empty doc file: @@ -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: -### 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. @@ -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. @@ -199,7 +199,7 @@ To change the input file, modify the `files` field of the hook and supply the co - ``` -### Using it manually +### Using it manually locally The `./panvimdoc.sh` script runs `pandoc` along with all the filters and custom output writer.