Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: clean up the site a bit #387

Merged
merged 1 commit into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,31 +1,71 @@
site_name: x509-limbo
site_description: x509-limbo
site_description: A testvector suite for X.509 path validators
site_url: https://x509-limbo.com
docs_dir: site
site_dir: site_html
dev_addr: "127.0.0.1:9999"

repo_url: https://github.com/C2SP/x509-limbo
edit_uri: edit/main/site

theme:
name: material
features:
- navigation.expand
- navigation.footer
- navigation.sections
- navigation.tracking
- content.action.edit
- content.action.view
- content.code.copy
- content.code.annotate
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode

# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default

toggle:
icon: material/brightness-7
name: Switch to dark mode

# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference

plugins:
- search
- gen-files:
scripts:
- site/render-testcases.py

markdown_extensions:
# Makes sure we render `<https://...>`-style links correctly.
- pymdownx.magiclink
- toc:
permalink: 🔗

extra_css:
- style.css

extra_javascript:
- https://unpkg.com/[email protected]/dist/tablesort.min.js
- js/tablesort.js

exclude_docs: |
render-testcases.py

validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn

copyright: "&copy; 2024 x509-limbo maintainers"
8 changes: 4 additions & 4 deletions site/render-testcases.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,23 +36,23 @@
LINK_SUBSTITUTIONS = [
# Rewrite `RFC XXXX A.B.C.D` into a section link.
(
r"(?<!\[)RFC (\d+) (\d+(?:.\d+)*)(?!\])",
re.compile(r"(?<!\[)RFC (\d+) (\d+(?:.\d+)*)(?!\])"),
r"[\g<0>](https://datatracker.ietf.org/doc/html/rfc\g<1>#section-\g<2>)",
),
# Rewrite bare `RFC XXXX` into an RFC link.
(
r"(?<!\[)RFC (\d+)(?!\])",
re.compile(r"(?<!\[)RFC (\d+)(?!\])"),
r"[\g<0>](https://datatracker.ietf.org/doc/html/rfc\g<1>)",
),
# Rewrite `CABF` into a PDF link.
# TODO(ww): Figure out a good way to hotlink to specific CABF sections.
(
r"(?<!\[)CABF(?!\])",
re.compile(r"(?<!\[)CABF(?!\])"),
r"[\g<0>](https://cabforum.org/wp-content/uploads/CA-Browser-Forum-BR-v2.0.1.pdf)",
),
# Rewrite `CVE-YYYY-ABCDEF` into a NIST NVD link.
(
r"(?<!\[)CVE-(\d{4})-(\d+(?:.\d+)*)(?!\])",
re.compile(r"(?<!\[)CVE-(\d{4})-(\d+(?:.\d+)*)(?!\])"),
r"[\g<0>](https://nvd.nist.gov/vuln/detail/CVE-\g<1>-\g<2>)",
),
]
Expand Down
Loading