Skip to content

Commit

Permalink
Add mkdocs validation and draft_docs
Browse files Browse the repository at this point in the history
Add mkdocs files and links validation

Files need to be somewhere, if not in nav, then in draft_docs.

Signed-off-by: Arthit Suriyawongkul <[email protected]>
  • Loading branch information
bact authored and goneall committed Jul 30, 2024
1 parent 9be3f54 commit 2d8ed65
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,17 @@ extra_css:
markdown_extensions:
- codehilite:
guess_lang: false
draft_docs: | # for preview with `mkdocs serve`, but excluded from `mkdocs build`
/conformance.md
strict: true
validation:
nav:
omitted_files: warn
not_found: warn
absolute_links: warn
links:
not_found: warn
anchors: warn
absolute_links: warn
unrecognized_links: warn
nav:
- 'Copyright': index.md
- 'Introduction': introduction.md
Expand All @@ -45,3 +54,6 @@ nav:
- licenses:
- 'Creative Commons Attribution License 3.0 Unported': licenses/CC-BY-3.0.md
- 'Community Specification License 1.0': licenses/Community-Spec-1.0.md
draft_docs: | # for preview with `mkdocs serve`, but excluded from `mkdocs build`
ISO_foreword.md
conformance.md

0 comments on commit 2d8ed65

Please sign in to comment.