Tou.md

A Github Action to find broken links in Markdown files.

The name Tou.md comes from the apheretic and informal form (tar) of the verb to be (estar) in Portuguese (and the filename extension for Markdown files).

Quickstart

name: Sample workflow

on:
  push:
    branches:
      - master

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Run Tou.md
        uses: joaopalmeiro/tou@v0.2.3
        with:
          ignore-403-forbidden: false

Acknowledgments

• https://github.com/paramt/url-checker
• https://stackoverflow.com/questions/19747371/python-exit-commands-why-so-many-and-when-should-each-be-used
• https://stackoverflow.com/questions/63143360/how-do-you-use-pipenv-in-a-github-action
• https://regex101.com/
• https://github.com/andrewp-as-is/markdown-link-extractor.py
• https://jex.im/regulex/ (visualization)
• https://github.com/medialab/ural
• https://github.com/Jtalk/url-health-check-action

Development

• pipenv install --python 3.7 and/or pipenv shell + python tou_url_checker.py.
• Update the version in the Dockerfile and in the README.md file.

Notes

• Check the path to the virtual environment: pipenv --venv.
• deadlink (CLI):
  • deadlink check README.md.
  • deadlink check --help.
• pyenv install 3.7.12.