diff --git a/README.md b/README.md index 6bf01ae..7a88172 100644 --- a/README.md +++ b/README.md @@ -119,12 +119,14 @@ 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 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. +[.github/workflows/docs.yml](./.github/workflows/docs.yml) file. -
+You can find the Markdown file you are reading right now converted to HTML here: https://kdheepak.com/panvimdoc/ + +Here's an example: ```yml name: docs @@ -158,8 +160,6 @@ jobs: folder: public ``` -
- ### Using pre-commit [pre-commit](https://pre-commit.com/) lets you easily install and manage pre-commit hooks locally.