GitHub Action: Run vim help html generator

action-vimhelp-html-generate

Generate html from Vim help (/doc)

Inputs

FOLDER

Optional. generate html store folder

default value: "build"

Example usage

Set workflow into vim plugin.

.github/workflows/vimhelpdeploy.yml

name: "deploy vim help to gh-pages"
on:
  push:
    branches:
      - master
jobs:
  ghpages:
    name: Convert and deploy vim help
    runs-on: ubuntu-latest
    steps:
      - name: checkout
        uses: actions/checkout@v1
      - name: generate html
        uses: tsuyoshicho/action-vimhelp-html-generate@v1
        env:
          FOLDER: build
          BACKGROUND: light
          COLORSCHEME: github
      - name: deploy gh-pages
        uses: JamesIves/github-pages-deploy-action@releases/v2
        env:
          ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
          BRANCH: gh-pages
          FOLDER: build

Special thanks

• thinca's vim docker image
• vim-jp vimdoc-jp help

License

CC0 1.0 Universal

vim-jp: vimdoc-ja-working's discussion.