docs: reformat readline help page with tables and external link #175
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Docs Lint | |
| on: | |
| push: | |
| paths: | |
| - '**.md' | |
| - '.markdownlint.yml' | |
| - '.markdown-link-check.json' | |
| pull_request: | |
| paths: | |
| - '**.md' | |
| - '.markdownlint.yml' | |
| - '.markdown-link-check.json' | |
| jobs: | |
| markdown-lint: | |
| name: Markdown Lint | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Run markdownlint | |
| uses: DavidAnson/markdownlint-cli2-action@v19 | |
| with: | |
| globs: | | |
| docs/**/*.md | |
| README.md | |
| CONTRIBUTING.md | |
| plugins/milk-extra-src/*/README.md | |
| src/*/README.md | |
| link-check: | |
| name: Link Check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Check relative links | |
| uses: gaurav-nelson/github-action-markdown-link-check@v1 | |
| with: | |
| config-file: '.markdown-link-check.json' | |
| folder-path: 'docs/' | |
| file-extension: '.md' | |
| use-quiet-mode: 'yes' | |
| spell-check: | |
| name: Spell Check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Check spelling | |
| uses: crate-ci/typos@v1.29.5 | |
| with: | |
| files: | | |
| docs/ | |
| README.md | |
| CONTRIBUTING.md | |
| plugins/milk-extra-src/*/README.md |