erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-11-05 18:44:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
spiegel-keyman/resources/tools/check-markdown
History
Marc Durdin f394245636 maint(common): consolidate builder scripts 
Clarifies the confusing builder.inc.sh / build-utils.sh distinction by
giving the scripts more appropriate names. Most build scripts should use
builder-full.inc.sh; some helper scripts can use builder-basic.inc.sh.
Documented in resources/build/README.md.

Renames:
* resources/build/builder.inc.sh to resources/build/builder-full.inc.sh
* resources/build/build-utils.sh to resources/build/builder-basic.inc.sh

Other changes:
* Moves Android-specific functions out of builder-basic.inc.sh and into
  android/build.sh.
* Renames functions in builder-basic.inc.sh

More functions may be moved from builder-basic.inc.sh into utils.inc.sh
or other scripts in the future.

Fixes: #14065
Build-bot: build all
Test-bot: skip
2025-08-02 08:11:24 +10: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 maint(common): consolidate builder scripts 2025-08-02 08:11:24 +10: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