Skip to content

chore: extra coverage args via env var. #889

chore: extra coverage args via env var.

chore: extra coverage args via env var. #889

Workflow file for this run

name: panvimdoc
on:
push:
branches-ignore:
- 'main'
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
name: pandoc to vimdoc
steps:
- uses: actions/checkout@v4
- name: panvimdoc
uses: kdheepak/panvimdoc@main
with:
vimdoc: "VectorCode" # Output vimdoc project name (required)
pandoc: "./docs/neovim/README.md" # Input pandoc file
toc: true # Table of contents
description: "A code repository indexing tool to supercharge your LLM experience." # Project description used in title (if empty, uses neovim version and current date)
titledatepattern: "%Y %B %d" # Pattern for the date that used in the title
demojify: true # 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
- name: panvimdoc
uses: kdheepak/panvimdoc@main
with:
vimdoc: "VectorCode-API" # Output vimdoc project name (required)
pandoc: "./docs/neovim/api_references.md" # Input pandoc file
toc: true # Table of contents
description: "A code repository indexing tool to supercharge your LLM experience." # Project description used in title (if empty, uses neovim version and current date)
titledatepattern: "%Y %B %d" # Pattern for the date that used in the title
demojify: true # 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
- name: panvimdoc
uses: kdheepak/panvimdoc@main
with:
vimdoc: "VectorCode-cli" # Output vimdoc project name (required)
pandoc: "./docs/cli.md" # Input pandoc file
toc: true # Table of contents
description: "A code repository indexing tool to supercharge your LLM experience." # Project description used in title (if empty, uses neovim version and current date)
titledatepattern: "%Y %B %d" # Pattern for the date that used in the title
demojify: true # 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@v6.0.1
with:
commit_message: "Auto generate docs"
branch: ${{ github.head_ref }}
file_pattern: 'doc/*.txt'