Generate docs on pull requests to main only #11
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: panvimdoc | ||
| on: | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| jobs: | ||
| docs: | ||
| permissions: contents: write | ||
| runs-on: ubuntu-latest | ||
| name: Create Docs 📚 | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: kdheepak/[email protected] | ||
| with: | ||
| vimdoc: gitlab.nvim | ||
| # The following are all optional | ||
| pandoc: "README.md" # Input pandoc file | ||
| toc: true # Table of contents | ||
| description: " Create, review, and manage Gitlab reources without leaving Neovim" | ||
| demojify: false # Strip emojis from the vimdoc | ||
| dedupsubheadings: false # Add heading to subheading anchor links to ensure that subheadings are unique | ||
| treesitter: true # Use treesitter for highlighting codeblocks | ||
| ignorerawblocks: true # Ignore raw html blocks in markdown when converting to vimdoc | ||
| docmapping: false # Use h4 headers as mapping docs | ||
| docmappingprojectname: false # Use project name in tag when writing mapping docs | ||
| shiftheadinglevelby: 0 # Shift heading levels by specified number | ||
| incrementheadinglevelby: 0 # Increment heading levels by specified number | ||
| - uses: stefanzweifel/git-auto-commit-action@v5 | ||
| with: | ||
| commit_message: "Auto generate docs" | ||
| branch: ${{ github.head_ref }} | ||
