mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-10-24 12:49:03 -05:00
feat: build the site with Astro Starlight
generate_site.py writes the Starlight project in website/ and nothing else: mkdocs.yml, the MkDocs hooks, theme overrides and stylesheet go, and the wiki is written in Starlight's syntax. Both workflows set up Node with the official actions/setup-node pinned by commit, run npm ci from the committed lockfile, build with the strict link validator and check the result with validate_site.py. The search weighs a page by what it answers: Start here pages first, a system page's cards and file names before a guide citing them, deep guides, launchers, aliases and frozen copies after. Status badges, hash blocks and the export change lists leave the index. The ranking sits at the centre of a range where the 13 queries of search_gate.py all answer, in the search box itself. 839 pages, every URL and 45,611 ids match the MkDocs build. The tests read the Starlight content and syntax.
This commit is contained in:
1 parent
abe240073c
commit
123d698e43
64 files changed
+742
-3118
No files matched your search
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Generate slim README.md from database.json and platform configs.
|
||||
|
||||
Detailed documentation lives on the MkDocs site (abdess.github.io/retrobios/).
|
||||
Detailed documentation lives on the site (abdess.github.io/retrobios/).
|
||||
This script produces a concise landing page with download links and coverage.
|
||||
|
||||
Usage:
|
||||
@@ -237,7 +237,7 @@ def download_links(
|
||||
|
||||
A pack published whole gets one link labelled *label*. A pack in parts
|
||||
gets one link per part, since every part is needed. *repo* is the
|
||||
repository URL, absolute or relative, and *attrs* a MkDocs attribute list
|
||||
repository URL, absolute or relative, and *attrs* an attribute list
|
||||
put after each link, or *button* the function that draws each link as a
|
||||
button on the site. Without a recorded release the link is the latest
|
||||
release page. A release recorded without this platform's pack says so and
|
||||
@@ -837,7 +837,7 @@ def contributing_text(
|
||||
|
||||
Two copies drifted apart: four steps to add a platform here, five on the
|
||||
site. *link* renders a site page (absolute URL for the README, relative
|
||||
.md for MkDocs); *site_words* names the site from where the text is read.
|
||||
.md for the site); *site_words* names the site from where the text is read.
|
||||
"""
|
||||
return f"""{title}
|
||||
|
||||
@@ -900,8 +900,7 @@ validation above is its check. For code, profiles or platform files, these are
|
||||
the checks CI runs on a pull request (Python 3.12 or newer):
|
||||
|
||||
```bash
|
||||
pip install pyyaml "jsonschema[format-nongpl]" markdown \\
|
||||
"mkdocs-material>=9.7.5,<10" "pymdown-extensions>=10.14"
|
||||
pip install pyyaml "jsonschema[format-nongpl]" markdown
|
||||
python scripts/validate_pr.py --changed # the BIOS files the branch adds
|
||||
python scripts/validate_schemas.py --source-only # profiles and platform files
|
||||
python scripts/profile_sync.py --changed --strict # each profile the branch adds or edits
|
||||
|
||||
Reference in new issue
Block a user