update readme #12
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Generate documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'README.md' | |
| - 'lua/**' | |
| - 'plugin/**' | |
| permissions: | |
| contents: write | |
| jobs: | |
| generate-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Generate Vim documentation | |
| uses: kdheepak/panvimdoc@main | |
| with: | |
| vimdoc: browsher | |
| pandoc: "README.md" | |
| description: "Create commit pinned links to git(hub | lab) hosted files/lines directly from Neovim" | |
| toc: true | |
| demojify: true | |
| - name: Commit and push changes | |
| uses: stefanzweifel/git-auto-commit-action@v4 | |
| with: | |
| commit_message: 'auto generate vimdoc' | |
| branch: ${{ github.ref }} | |
| file_pattern: doc/browsher.txt | |
| commit_user_name: 'github-actions[bot]' | |
| commit_user_email: 'github-actions[bot]@users.noreply.github.com' |