diff --git a/.github/generated-files-bot.yml b/.github/generated-files-bot.yml index b86628b..e7cda27 100644 --- a/.github/generated-files-bot.yml +++ b/.github/generated-files-bot.yml @@ -1,5 +1,6 @@ generatedFiles: - path: "doc/nvim-autopairs.txt" + - path: "doc/nvim-autopairs-rules.txt" message: "`nvim-autopairs.txt` is generated from README.md. Make changes there instead." ignoreAuthors: - 'github-actions[bot]' diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 7d283c4..f79e0fe 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -6,7 +6,6 @@ on: - README.md branches: - master - jobs: docs: runs-on: ubuntu-latest @@ -30,10 +29,22 @@ jobs: with: vimdoc: nvim-autopairs description: A super powerful autopair for Neovim. + - name: clone rules api docs + run: | + git clone --depth 1 https://github.com/windwp/nvim-autopairs.wiki.git ../nvim-autopairs.wiki + cp ../nvim-autopairs.wiki/Rules-API.md ./Rules-API.md + - name: panvimdoc + uses: kdheepak/panvimdoc@v2.7.1 + with: + vimdoc: nvim-autopairs-rules + description: nvim-autopairs rules + pandoc: "Rules-API.md" + toc: true - name: Create PR run: | if ! [[ -z $(git status -s) ]]; then git add doc/nvim-autopairs.txt + git add doc/nvim-autopairs-rules.txt git commit -m "chore: generated vimdoc" git push --force https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY} ${VIMDOC_BRANCH} gh pr create --fill --base ${GITHUB_REF#refs/heads/} --head ${VIMDOC_BRANCH} || true diff --git a/README.md b/README.md index 8c73c76..bb0a535 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@ Requires neovim 0.5+ ### Setup ``` lua require('nvim-autopairs').setup{} - ``` ## Default values