nvims.yml

name: nvims

on:
  workflow_dispatch:
  push:
    paths:
      - "**vims.1.md"

jobs:
  docs:
    runs-on: ubuntu-latest
    name: pandoc to vimdoc
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ github.head_ref }}
      - name: Nvims
        uses: kdheepak/panvimdoc@v4.0.1
        with:
          vimdoc: Nvims # Output vimdoc project name (required)
          # The following are all optional
          pandoc: "markdown/nvims.1.md" # Input pandoc file
          version: "NVIM v0.9.0" # Vim version number
          toc: false # Table of contents
          description: "Fuzzy search and select from multiple Neovim configurations"
          demojify: false # Strip emojis from the vimdoc
          dedupsubheadings: true # 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: true # 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 }}