RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 03:57:44 +00:00
Code Issues Activity Actions

markdown-check: Allow generating a manpage link graph

Browse source 
Using the cross-page links, we can generate a directed graph showing the
topology of which pages refer to other pages. This is not just for fun:
the links show how often a page is linked (since links are not
deduplicated on purpose), which pairs of pages only have links in one
direction (where a link in the other direction may be useful), which
groups of closely-interlinked pages exist, and which pages have few or
no links to other pages.

The EXTRA_MARKDOWN_CHECK_ARGS argument to the check-markdown script can
be used to inject the -g flag for generating the graph on all manpages.
This commit is contained in:
kleines Filmröllchen 2023-07-02 13:20:23 +02:00 • committed by Linus Groh
parent f53aa959df
commit d7a2b5e65b
4 changed files with 96 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

3
Meta/Lagom/CMakeLists.txt
View file

@ -400,6 +400,7 @@ if (BUILD_LAGOM)
JS
Line
Locale
Manual
Markdown
PDF
Regex
@ -548,7 +549,7 @@ if (BUILD_LAGOM)
target_link_libraries(lzcat LibCompress LibCore LibMain)
add_executable(markdown-check ../../Userland/Utilities/markdown-check.cpp)
target_link_libraries(markdown-check LibFileSystem LibMarkdown LibMain)
target_link_libraries(markdown-check LibFileSystem LibMarkdown LibMain LibManual)
if (NOT EMSCRIPTEN)
add_executable(ntpquery ../../Userland/Utilities/ntpquery.cpp)

3
Meta/check-markdown.sh
View file

@ -23,4 +23,5 @@ if [ -z "$SERENITY_SOURCE_DIR" ] ; then
export SERENITY_SOURCE_DIR
fi
find AK Base Documentation Kernel Meta Ports Tests Userland -path Tests/LibWeb/WPT/wpt -prune -o -type f -name '*.md' -print0 | xargs -0 "${MARKDOWN_CHECK_BINARY}" README.md CONTRIBUTING.md
# shellcheck disable=SC2086 # Word splitting is intentional here
find AK Base Documentation Kernel Meta Ports Tests Userland -path Tests/LibWeb/WPT/wpt -prune -o -type f -name '*.md' -print0 | xargs -0 "${MARKDOWN_CHECK_BINARY}" -b "${SERENITY_SOURCE_DIR}/Base" $EXTRA_MARKDOWN_CHECK_ARGS README.md CONTRIBUTING.md