Skip to content

specs, CI, workflows, minor fixes, refactoing #5

specs, CI, workflows, minor fixes, refactoing

specs, CI, workflows, minor fixes, refactoing #5

Workflow file for this run

name: Documentation
on:
push:
branches:
- main
- develop
jobs:
documentation:
name: Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- uses: rhysd/action-setup-vim@v1
with:
neovim: true
version: stable
- name: Create API Documentation
run: |
nvim --version
make api_documentation
- name: Create User Documentation
uses: kdheepak/panvimdoc@main
with:
vimdoc: lua-console.nvim # Output vimdoc project name (required)
# The following are all optional
pandoc: "README.md" # Input pandoc file
version: "Neovim >= 0.8.0"
toc: true # Table of contents
description: A handy scratch pad / REPL / debug console for Lua development and Neovim exploration and configuration
titledatepattern: "%Y %B %d" # Pattern for the date that used in the title
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
- name: Generate Tags
run: |
nvim -c 'helptags doc' -c 'quit'
- name: Push Changes
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "docs(vimdoc): Auto-generate user / API documentation + vimtags"
commit_user_name: "github-actions[bot]"
commit_user_email: "github-actions[bot]@users.noreply.github.com"
commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"