erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-06 17:05:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13
spiegel-keyman/resources/tools/check-markdown
History
Marc Durdin 9f15e7c7ec maint: add empty 'scripts' tag to package.json to silence warning 
Also removes './' from front of gosh.js to address another npm cleanup
(from `npm pkg fix`).

Fixes: #13833
2025-05-25 06:35:28 +07:00
..
src chore(common): address review comments 2024-10-09 08:16:16 +07:00
.gitignore test(developer): add markdown link check test for product documentation 2024-09-25 15:51:32 -07:00
build.sh fix(common): fix configure step in check-markdown 2025-04-29 11:54:39 +02:00
package.json maint: add empty 'scripts' tag to package.json to silence warning 2025-05-25 06:35:28 +07:00
README.md chore(common): address review comments 2024-10-09 08:16:16 +07:00
tsconfig.json test(developer): add markdown link check test for product documentation 2024-09-25 15:51:32 -07:00

README.md

check-markdown

This tool is used to test the validity of internal links within product documentation, e.g. /android/docs/help/**/*.md.

It currently tests that:

  1. Markdown can be parsed
  2. Links to other files in the same section exist (with or without .md extension)
  3. Images exist

It will also optionally report on:

  1. External absolute links (starting with http/https)
  2. Relative links outside the root of the help documentation
  3. Unnecessary use of .md extension in links

We could extend it to include:

  1. Checks for anchor validity