erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-11 03:15:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 20
spiegel-keyman/resources/tools/check-markdown
History
Exact
Marc Durdin 2726050601 maint(common): rename and move node-related script functions into node.inc.sh 
Consolidates the node-related script functions into node.inc.sh, as part
of cleaning up the build scripts and making them easier to maintain into
the future.

Fixes: #14447
2025-08-02 13:34:29 +10:00
..
src
.gitignore
build.sh maint(common): rename and move node-related script functions into node.inc.sh 2025-08-02 13:34:29 +10:00
package.json
README.md
tsconfig.json

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