Skip to content

Commit

Permalink
fix: Crank up strictness of mkdocs to prevent non-working links in th…
Browse files Browse the repository at this point in the history
…e future
  • Loading branch information
tuxuser committed Dec 23, 2024
1 parent 4b23c09 commit 48b4e75
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 5 deletions.
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
build: ## Build docs locally
mkdocs build --clean
mkdocs build --strict --clean

serve: ## Serve live version of your docs
mkdocs serve
mkdocs serve --strict

all: build
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ source venv/bin/activate
4. Install needed python dependencies using python package manager -> pip

```sh
pip install mkdocs mkdocs-material
pip install -r requirements.txt
```

5. At this point, load up the clone repository in a text editor that has live-markdown preview function.
Expand All @@ -68,12 +68,12 @@ pip install mkdocs mkdocs-material

Build the documentation
```sh
make build
make build --strict
```

Serve the documentation
```sh
make serve
make serve --strict
```

7. Once you are happy and the added changes are looking proper, you are ready to submit your work.
Expand Down
21 changes: 21 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
site_name: Free60 Wiki
site_description: Archive from Free60 MediaWiki.
repo_url: https://github.com/Free60Project/wiki

theme:
name: material
palette:
Expand All @@ -15,13 +17,31 @@ theme:
- navigation.tabs
- navigation.tabs.sticky
- navigation.indexes
- content.action.view
- content.action.edit

markdown_extensions:
- attr_list
- pymdownx.highlight:
anchor_linenums: true
use_pygments: true
pygments_lang_class: true
- pymdownx.magiclink
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tilde

validation:
nav:
omitted_files: warn
not_found: warn
absolute_links: warn
links:
not_found: warn
absolute_links: warn
unrecognized_links: warn

nav:
- Home:
- 'index.md'
Expand Down Expand Up @@ -114,6 +134,7 @@ nav:
- Xenon Toolchain: 'Development/Xenon_Toolchain.md'
- Xenos Framebuffer: 'Development/Xenos_Framebuffer.md'
- ToDo: '!TODO.md'

plugins:
search: {}
redirects:
Expand Down

0 comments on commit 48b4e75

Please sign in to comment.