As with code, it’s good practice to run automated checks on our docs too.
lint•er : noun
- a machine for removing the short fibers from cotton seeds after ginning
- a static code analysis tool used to flag programming errors, bugs, stylistic errors and suspicious constructs
Checking for broken links
Linkcheck has some issues with localhost that we’re working on resolving. Until then, you can set up your local site to run through Cloudflare Tunnel and then run it.
linkcheck -e https://your-site-url.example.com/docs/some/path --skip-file .linkcheck_skip.txt- run the linkchecker on internal (default) and external (
-e) links with our custom ignore file (
markdownlint-cli2 --fix "content/en/docs/user-documentation/paragraphs/**/*.md"- lint and fix the Paragraphs directory
Last modified August 31, 2023: DS-28 docs: Add linting instructions (401a0845)