Skip to content

Commit 5e26186

Browse files
kdheepakgithub-actions[bot]
authored andcommitted
Auto generate docs
1 parent f57c0b2 commit 5e26186

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

doc/panvimdoc.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ USING GITHUB ACTIONS ~
9595
Create an empty doc file:
9696

9797
>bash
98-
touch doc/.gitkeepp
98+
touch doc/.gitkeep
9999
git commit -am "Add empty doc folder"
100100
git push
101101
<
@@ -116,7 +116,7 @@ Then add the following to `./.github/workflows/panvimdoc.yml`:
116116
- name: panvimdoc
117117
uses: kdheepak/panvimdoc@main
118118
with:
119-
vimdoc: ${VIMDOC_PROJECT_NAME} # Output vimdoc project name (required)
119+
vimdoc: __VIMDOC_PROJECT_NAME_HERE__ # Output vimdoc project name (required)
120120
# The following are all optional
121121
pandoc: "README.md" # Input pandoc file
122122
version: "NVIM v0.8.0" # Vim version number
@@ -133,9 +133,10 @@ Then add the following to `./.github/workflows/panvimdoc.yml`:
133133
incrementheadinglevelby: 0 # Increment heading levels by specified number
134134
<
135135

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

140141
>yaml
141142
- name: panvimdoc

0 commit comments

Comments
 (0)