Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joaopalmeiro/tou
A Github Action to find broken links in Markdown files.
https://github.com/joaopalmeiro/tou
actions link-checker markdown python url-checker
Last synced: 7 days ago
JSON representation
A Github Action to find broken links in Markdown files.
- Host: GitHub
- URL: https://github.com/joaopalmeiro/tou
- Owner: joaopalmeiro
- License: mit
- Created: 2020-08-07T11:45:19.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-11-23T13:53:33.000Z (about 3 years ago)
- Last Synced: 2025-01-13T14:43:45.552Z (18 days ago)
- Topics: actions, link-checker, markdown, python, url-checker
- Language: Python
- Homepage: https://github.com/marketplace/actions/tou-md
- Size: 44.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tou.md
A [Github Action](https://docs.github.com/en/actions) to find broken links in Markdown files.
The name `Tou.md` comes from the [apheretic](https://en.wiktionary.org/wiki/apheresis) and informal form ([_tar_](https://www.flip.pt/Duvidas-Linguisticas/Duvida-Linguistica/DID/1878)) of the verb to be ([_estar_](https://en.wiktionary.org/wiki/estar#Portuguese)) in Portuguese (and the filename extension for [Markdown files](https://en.wikipedia.org/wiki/Markdown)).
## Quickstart
```yml
name: Sample workflow
on:
push:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Run Tou.md
uses: joaopalmeiro/[email protected]
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](https://github.com/nschloe/deadlink) (CLI):
- `deadlink check README.md`.
- `deadlink check --help`.
- `pyenv install 3.7.12`.