README

Publishing this wiki

GitHub wikis live in a separate git repository: https://github.com/paulmann/HTML.PHP.wiki.git. This folder (wiki/) is the source of truth kept next to the code so documentation changes can be reviewed in the same PR as the change itself.

First publish

git clone https://github.com/paulmann/HTML.PHP.wiki.git /tmp/htmlphp-wiki
cd /tmp/htmlphp-wiki
cp /path/to/HTML.PHP/wiki/*.md .
git add -A
git commit -m "wiki: HTML.PHP 4.0.0 documentation set"
git push origin main        # branch may be 'master' on older wikis

Keeping it in sync

bash tools/publish-wiki.sh  # clones/pulls the wiki repo, rsyncs wiki/, commits, pushes

The script is dry-run by default (--push to actually publish) and refuses to run with a dirty working tree in the main repo.

Conventions

• File names = wiki URLs. Template-Syntax.md → /wiki/Template-Syntax. Keep them stable; GitHub does not redirect renamed pages.
• Internal links are relative page names: [SSI Guide](SSI-Guide) — no .md, no /wiki/ prefix.
• Repository links are absolute GitHub URLs (relative links would resolve against the wiki repo, not the code repo).
• Home.md, _Sidebar.md, _Footer.md are GitHub magic files — keep them.
• Use GitHub-flavored Markdown: alerts (> [!NOTE] …), mermaid fences, <details> blocks, footnotes. All render on github.com as of 2026.
• The CI job wiki-links (see .github/workflows/ci.yml) verifies every internal link resolves to a file in wiki/ — run it locally:

php tools/check-wiki-links.php