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 bcd221f commit f57c0b2
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ vimdoc.
Create an empty doc file:

```bash
touch doc/.gitkeepp
touch doc/.gitkeep
git commit -am "Add empty doc folder"
git push
```
Expand All @@ -68,7 +68,7 @@ jobs:
- name: panvimdoc
uses: kdheepak/panvimdoc@main
with:
vimdoc: ${VIMDOC_PROJECT_NAME} # Output vimdoc project name (required)
vimdoc: __VIMDOC_PROJECT_NAME_HERE__ # Output vimdoc project name (required)
# The following are all optional
pandoc: "README.md" # Input pandoc file
version: "NVIM v0.8.0" # Vim version number
Expand All @@ -85,7 +85,7 @@ jobs:
incrementheadinglevelby: 0 # Increment heading levels by specified number
```

The only required thing for you to do is to choose a `VIMDOC_PROJECT_NAME` appropriately. This is
The only required thing for you to do is to choose a `__VIMDOC_PROJECT_NAME_HERE__` appropriately. This is
usually the name of the plugin or the documentation file without the `.txt` extension. For example,
the following:

Expand Down Expand Up @@ -161,6 +161,7 @@ jobs:
</details>

### Using pre-commit

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

Two hooks are available, differing only in the way dependencies are handled:
Expand Down

0 comments on commit f57c0b2

Please sign in to comment.