README

About this wiki

This repository (HTML.PHP.wiki.git) is the source of truth for the HTML.PHP wiki — GitHub renders every .md file here as a page. Edit pages by cloning this repo and pushing, or through the GitHub web UI.

git clone https://github.com/paulmann/HTML.PHP.wiki.git

Structure

• Home.md — landing page (GitHub shows it at /wiki).
• _Sidebar.md / _Footer.md — GitHub magic files, rendered on every page.
• HTML.PHP-🧩⚡.md — artifact of the initial wiki creation; kept as a pointer to Home. Safe to delete through the GitHub UI.
• Everything else: one topic per page; file names are URLs — keep them stable, GitHub does not redirect renamed pages.

Tooling (lives in the main repository)

The main repo (paulmann/HTML.PHP) ships two tools for this wiki:

Tool	Purpose
tools/check-wiki-links.php	validates every internal page link and heading anchor (GitHub slug rules), plus sidebar orphans. Usage: php tools/check-wiki-links.php /path/to/wiki-checkout
tools/publish-wiki.sh	optional convenience for maintainers who keep a local wiki/ mirror: runs the link check, rsyncs WIKI_SRC (default ./wiki) into a clone of this repo, commits; --push to publish. Dry-run by default

The main repo's CI runs the link checker against this repository on every push/PR (job wiki-links in .github/workflows/ci.yml) — broken wiki navigation fails the build:

# what CI does:
git clone --depth 1 https://github.com/paulmann/HTML.PHP.wiki.git wiki-checkout
php tools/check-wiki-links.php wiki-checkout

Conventions

• Internal links are relative page names: [SSI Guide](SSI-Guide) — no .md, no /wiki/ prefix. Links to the codebase use absolute GitHub URLs (relative links would resolve against this repo).
• GitHub-flavored Markdown: alerts (> [!NOTE] …), mermaid fences, <details> blocks, task lists. All render on github.com.
• Numbers in badges/tables (tests, assertions) must match the current main — they are updated together with releases; state the measurement environment when quoting results.
• Tutorial/reference pages mirror the versioned docs in docs/: behaviour changes update both in the same PR.