-
-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(common): address review comments
- Loading branch information
Showing
2 changed files
with
21 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters