マークダウンからドキュメントの整備をする備忘録

name: text linter action
on:
  push:
    branches:
      - main
    paths:
      - "**/*.md"

jobs:
  RunTextLint:
    runs-on: ubuntu-latest
    steps:
      - name: checkout repository
        uses: actions/checkout@v2
      - name: node install
        shell: bash
        run: |
          npm install
      - name: run text lint
        shell: bash
        run: |
          npm run lint

{
  "filters": {},
  "rules": {
    "preset-ja-technical-writing": {
      "max-kanji-continuous-len": {
          "max": 10,
          allow: ["***報告書"]
      },
      "no-exclamation-question-mark": {
        allow: ["/\"w+?\"/g"]
      },
      "sentence-length": {
          "max": 200
      }
    }
  }
}

# wget https://github.com/jgm/pandoc/releases/download/2.16.1/pandoc-2.16.1-1-amd64.deb
# sudo dpkg -i pandoc-2.16.1-1-amd64.deb
# which pandoc
/usr/bin/pandoc

$ pandoc --version
pandoc 2.16.1

#!/bin/bash
pandoc ${1}.md -t docx -o ${1}.docx

$ for i in $(ls *.md|grep -v README|sed -e 's/.md//g'); do bash ./make.sh $i; done

vi .github/workflows/githubAction.yaml

name: docs md to docx
# 手動で動くtrigger
on: [ workflow_dispatch ]
# pushされたら動くtrigger
#  push:
#    branches:
#      - main
#    paths-ignore:
#      - ".github/workflows/githubAction.yaml"

# ubuntuで、リポジトリチェックアウトしてpandoc入れて変換して成果物をアップロードする
jobs:
  ConvertDocument:
    runs-on: ubuntu-latest
    steps:
      - name: checkout repository
        uses: actions/checkout@v2
      - name: install pandoc
        shell: bash
        run: |
          wget https://github.com/jgm/pandoc/releases/download/2.16.1/pandoc-2.16.1-1-amd64.deb
          sudo dpkg -i pandoc-2.16.1-1-amd64.deb
          pandoc --version
      - name: convert ConvertDocument
        shell: bash
        run: |
          for i in $(ls *.md|grep -v README|sed -e 's/.md//g'); do bash ./make.sh $i; done
      #TODO 成果物アップロードのところをblobにしたければする
      # https://docs.github.com/ja/[email protected]/admin/github-actions/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage
      # https://docs.github.com/ja/actions/advanced-guides/storing-workflow-data-as-artifacts#uploading-build-and-test-artifacts
      #- name: upload artifact
      #  uses: actions/upload-artifact@v2