diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/FUTURE_PROOF.md | 54 | ||||
| -rw-r--r-- | docs/MANAGE.md | 42 |
2 files changed, 96 insertions, 0 deletions
diff --git a/docs/FUTURE_PROOF.md b/docs/FUTURE_PROOF.md new file mode 100644 index 0000000..7325798 --- /dev/null +++ b/docs/FUTURE_PROOF.md @@ -0,0 +1,54 @@ +# Future Proofing (No Generator) + +This site is intentionally hand-edited HTML. The goal here is to keep the *style* the same while making the site easier to maintain and more resilient. + +## Principles + +- Navigation and core content should work without JavaScript. +- External embeds should always have a plain-link fallback. +- URLs should be stable; if something must move, leave a redirect page. +- Translations should follow a consistent naming rule. + +## What We Added + +### 1) A real sitemap and robots.txt + +- `robots.txt` points to `sitemap.xml` +- `sitemap.xml` is the public crawl map (update when adding new sections) + +### 2) A human-friendly site map page + +- `/map/` provides a clickable index for humans +- It also links to translated versions + +### 3) Translation naming convention + +- Default English: `index.html` (or any `page.html`) +- Simplified Chinese: `index_zh.html` (or `page_zh.html`) +- Japanese: `index_jp.html` (or `page_jp.html`) + +### 4) Redirect page pattern + +If you ever rename or move a page, keep an old file that points to the new place. + +Example: create `old-path/index.html`: + +```html +<!doctype html> +<meta charset="utf-8"> +<meta http-equiv="refresh" content="0; url=/new-path/"> +<link rel="canonical" href="/new-path/"> +<title>Moved</title> +<p>This page moved to <a href="/new-path/">/new-path/</a>.</p> +``` + +### 5) Backups + +Recommended: + +- Put the folder in git (local is enough) +- Mirror the repo remotely (GitHub/GitLab/SourceHut) even if you don’t deploy from it + +## Optional Next Step + +Add a simple link-check script (offline) to catch broken internal links. diff --git a/docs/MANAGE.md b/docs/MANAGE.md new file mode 100644 index 0000000..e061837 --- /dev/null +++ b/docs/MANAGE.md @@ -0,0 +1,42 @@ +# Site Management (No Generator) + +This site is intentionally hand-edited HTML/CSS. + +## Shared assets + +- Global CSS: `/assets/css/site.css` +- Shared JS (menu + language + blog list): `/assets/js/site.js` + +## Optional includes (header/footer) + +If you want to stop copy/pasting the header/footer without using a static site generator: + +1) Add include placeholders: + +```html +<div data-include="header"></div> +... +<div data-include="footer"></div> +``` + +2) Add this script: + +```html +<script defer src="/assets/js/includes.js"></script> +``` + +3) Header/footer live here: + +- `/partials/header.html` +- `/partials/footer.html` + +Notes: + +- This is a "no build" approach. +- It requires JavaScript to render header/footer. +- If includes fail (offline, blocked fetch), the page still loads (just without injected header/footer). + +## SEO / crawl basics + +- `robots.txt` points to `sitemap.xml`. +- Update `sitemap.xml` when you add/remove top-level pages. |