Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| e286139572 | |||
| c49c8348d2 | |||
| 7a9c88a05a | |||
| 422d6622a2 | |||
| bd932c36b2 | |||
| c08371647d | |||
| 8be53c1e25 | |||
| 627c0ee887 |
@@ -6,4 +6,5 @@
|
||||
**/*.pyc
|
||||
**/*.tsbuildinfo
|
||||
.artifacts
|
||||
apps/docs/public/figures/**/*.webp
|
||||
.env*
|
||||
|
||||
@@ -11,3 +11,6 @@ __pycache__/
|
||||
!.env.example
|
||||
|
||||
.artifacts/
|
||||
|
||||
# Browser raster derivatives are generated on the confirmed remote runner.
|
||||
/apps/docs/public/figures/**/*.webp
|
||||
|
||||
@@ -30,7 +30,7 @@ tools/figures/ 独立 Python 项目,使用 drawsvg 编程制图
|
||||
- `pnpm start`:在本地预览已构建站点。
|
||||
- `pnpm check`:依次执行 lint、类型检查、制图与构建。
|
||||
|
||||
站点默认浅色,使用本地系统字体。全站搜索支持正文关键词、`⌘/Ctrl K`、方向键与 Enter;代码块提供复制与反馈。桌面提供分组导航和滚动高亮的页内目录,小屏可展开文档菜单与页内目录。首页入口、草案提示、前后篇导航均引用现有 Markdown 内容和资料目录配置。
|
||||
站点默认浅色,使用本地系统字体。全站搜索支持正文关键词、`⌘/Ctrl K`、方向键与 Enter;代码块提供复制与反馈。桌面提供分组导航和滚动高亮的页内目录,小屏可展开文档菜单与页内目录。首页入口、草案提示、前后篇导航均引用现有 Markdown 内容和资料目录配置。顶部提供文档切换,阅读页左侧只展示当前文档,并有独立图标、名称与返回入口;搜索框标明当前文档范围。界面主要通过留白、轻渐变与状态反馈分层,支持减少动态效果的系统偏好。
|
||||
|
||||
参考设计截图与研究记录保存在 `design/references`;浏览器验收截图与检查说明保存在 `design/verification`。这些文件不作为站点静态资源发布。
|
||||
|
||||
|
||||
@@ -3,8 +3,10 @@
|
||||
"version": "0.1.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"dev": "NEXT_TELEMETRY_DISABLED=1 next dev --hostname 127.0.0.1",
|
||||
"build": "NEXT_TELEMETRY_DISABLED=1 next build && node scripts/build-auth.mjs",
|
||||
"dev": "node scripts/build-doc-images.mjs && NEXT_TELEMETRY_DISABLED=1 next dev --hostname 127.0.0.1",
|
||||
"build": "node scripts/build-doc-images.mjs && NEXT_TELEMETRY_DISABLED=1 next build && node scripts/build-auth.mjs",
|
||||
"images": "node scripts/build-doc-images.mjs",
|
||||
"test:images": "node scripts/build-doc-images.mjs --check",
|
||||
"start": "NEXT_TELEMETRY_DISABLED=1 next start --hostname 127.0.0.1",
|
||||
"lint": "eslint . --max-warnings=0",
|
||||
"typecheck": "NEXT_TELEMETRY_DISABLED=1 next typegen && tsc --noEmit",
|
||||
@@ -29,6 +31,7 @@
|
||||
"eslint": "^9.39.5",
|
||||
"eslint-config-next": "16.4.3",
|
||||
"postcss": "8.5.31",
|
||||
"sharp": "0.35.5",
|
||||
"tailwindcss": "4.3.3",
|
||||
"typescript": "~5.9.3"
|
||||
}
|
||||
|
||||
@@ -141,6 +141,8 @@ async function main() {
|
||||
"/",
|
||||
"/docs/00-endor-concepts-draft",
|
||||
"/figures/endor-architecture.svg",
|
||||
"/figures/endor-review-gate.webp",
|
||||
"/figures/endor-review-desk.webp",
|
||||
"/docs/pretext/01-chapter",
|
||||
"/materials/pretext/verify.cjs",
|
||||
"/materials/pretext/results.chrome156.json",
|
||||
@@ -182,15 +184,61 @@ async function main() {
|
||||
const searchResponse = await request("/api/search", { headers });
|
||||
assert.equal(searchResponse.status, 200);
|
||||
const searchIndex = await searchResponse.json();
|
||||
assert.ok(searchIndex.some((doc: { slug: string; searchText: string }) => doc.slug === "pretext/04-chapter" && doc.searchText.includes("getSegmentMetrics")));
|
||||
assert.ok(searchIndex.some((doc: { slug: string; searchText: string }) => doc.slug === "source-studies/pretext/measurement-cache" && doc.searchText.includes("getSegmentMetrics")));
|
||||
for (const doc of searchIndex as { slug: string; sourceSlug: string }[]) {
|
||||
assert.ok(!doc.slug.split("/").some((part) => /^\d+-/.test(part)), doc.slug);
|
||||
const legacy = await request(`/docs/${doc.sourceSlug}?from=legacy`, { headers });
|
||||
assert.equal(legacy.status, 308, doc.sourceSlug);
|
||||
const destination = new URL(legacy.headers.get("location")!, base);
|
||||
assert.equal(destination.pathname, `/docs/${doc.slug}`);
|
||||
assert.equal(destination.searchParams.get("from"), "legacy");
|
||||
assert.ok(legacy.headers.get("cache-control")?.includes("no-store"));
|
||||
}
|
||||
let home = "";
|
||||
let purpose = "";
|
||||
for (const route of routes) {
|
||||
const response = await request(route, { headers });
|
||||
assert.equal(response.status, 200, route);
|
||||
if (route === "/") home = await response.text();
|
||||
const html = await response.text();
|
||||
if (route === "/") home = html;
|
||||
if (route === "/docs/endor/endor-purpose-draft") purpose = html;
|
||||
if (route.startsWith("/docs/")) {
|
||||
assert.ok(html.includes('aria-label="文档选择"'), route);
|
||||
assert.ok(html.includes('<optgroup label="语言与运行时">'), route);
|
||||
assert.ok(!html.includes('class="nav-back"'), route);
|
||||
const ids = [...html.matchAll(/<h[23] id="([^"]+)"/g)].map((match) => match[1]);
|
||||
assert.equal(new Set(ids).size, ids.length, `Unique heading anchors: ${route}`);
|
||||
for (const id of ids) assert.ok(html.includes(`href="#${id}"`), `TOC anchor: ${route}#${id}`);
|
||||
}
|
||||
}
|
||||
assert.ok(home.includes("资料库"));
|
||||
assert.ok(home.includes("/docs/pretext/00-overview"));
|
||||
assert.ok(home.includes("/docs/source-studies/pretext/overview"));
|
||||
// Inline preview and zoom dialog must both use the compressed browser asset.
|
||||
assert.equal(
|
||||
[...purpose.matchAll(/<img\b[^>]*\bsrc="\/figures\/endor-review-gate\.webp"/g)].length,
|
||||
2,
|
||||
"The comic preview and lightbox must use WebP",
|
||||
);
|
||||
assert.ok(purpose.includes('aria-label="上一张图片"'));
|
||||
assert.ok(purpose.includes('aria-label="下一张图片"'));
|
||||
assert.ok(purpose.includes('aria-label="显示第 1 张图片" aria-current="true"'));
|
||||
assert.ok(purpose.includes('aria-label="显示第 2 张图片"'));
|
||||
assert.equal(
|
||||
[...purpose.matchAll(/<img\b[^>]*\bsrc="\/figures\/endor-review-desk\.webp"/g)].length,
|
||||
0,
|
||||
"The second slide should not download until selected",
|
||||
);
|
||||
for (const name of ["endor-review-gate", "endor-review-desk"]) {
|
||||
assert.ok(!purpose.includes(`/figures/${name}.png`));
|
||||
const comic = await request(`/figures/${name}.webp`, { headers });
|
||||
assert.equal(comic.status, 200);
|
||||
assert.match(comic.headers.get("content-type") || "", /image\/webp/);
|
||||
assert.deepEqual(
|
||||
Buffer.from(await comic.arrayBuffer()),
|
||||
readFileSync(join(__dirname, `public/figures/${name}.webp`)),
|
||||
);
|
||||
assert.equal((await request(`/figures/${name}.png`, { headers })).status, 404);
|
||||
}
|
||||
const assets = new Set(
|
||||
[...home.matchAll(/(?:src|href)="(\/_next\/static\/[^" ]+)"/g)].map((m) =>
|
||||
m[1].replaceAll("&", "&"),
|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
import { mkdir, readFile, readdir, writeFile } from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import sharp from "sharp";
|
||||
|
||||
const root = fileURLToPath(new URL("../../../", import.meta.url));
|
||||
const sources = path.join(root, "tools/figures/assets");
|
||||
const output = path.join(root, "apps/docs/public/figures");
|
||||
const check = process.argv.includes("--check");
|
||||
const policy = JSON.parse(await readFile(path.join(root, "content/image-policy.json"), "utf8"));
|
||||
|
||||
async function files(directory) {
|
||||
const entries = await readdir(directory, { withFileTypes: true });
|
||||
return (await Promise.all(entries.map((entry) => {
|
||||
const name = path.join(directory, entry.name);
|
||||
return entry.isDirectory() ? files(name) : [name];
|
||||
}))).flat().sort();
|
||||
}
|
||||
|
||||
// Originals stay outside public; both inline and lightbox images use the WebP.
|
||||
for (const name of await files(path.join(root, "apps/docs/public"))) {
|
||||
if (/\.(?:png|jpe?g|tiff?|bmp)$/i.test(name)) {
|
||||
throw new Error(`Original raster exposed in public: ${path.relative(root, name)}. Move it to tools/figures/assets and run images.`);
|
||||
}
|
||||
}
|
||||
for (const name of await files(path.join(root, "content/docs"))) {
|
||||
if (!name.endsWith(".md")) continue;
|
||||
const content = await readFile(name, "utf8");
|
||||
const images = [
|
||||
...content.matchAll(/!\[[^\]]*\]\(<?([^\s)>]+)/g),
|
||||
...content.matchAll(/<img\b[^>]*\bsrc=["']([^"']+)/gi),
|
||||
];
|
||||
for (const [, source] of images) {
|
||||
if (/\.(?:png|jpe?g|tiff?|bmp)(?:[?#]|$)/i.test(source)) {
|
||||
throw new Error(`${path.relative(root, name)} embeds an original raster: ${source}. Use the compressed WebP.`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
await mkdir(output, { recursive: true });
|
||||
for (const source of await files(sources)) {
|
||||
if (!/\.(?:png|jpe?g|tiff?|bmp)$/i.test(source)) continue;
|
||||
const relative = path.relative(sources, source).replace(/\.[^.]+$/, ".webp");
|
||||
const destination = path.join(output, relative);
|
||||
const original = await readFile(source);
|
||||
const encoded = await sharp(original)
|
||||
.rotate()
|
||||
.resize({ width: policy.maxWidth, withoutEnlargement: true })
|
||||
.webp({ quality: policy.quality, effort: 6 })
|
||||
.toBuffer();
|
||||
if (encoded.length > policy.maxBytes) {
|
||||
throw new Error(`${relative}: ${encoded.length} bytes exceeds the ${policy.maxBytes}-byte image budget.`);
|
||||
}
|
||||
if (check) {
|
||||
const generated = await readFile(destination);
|
||||
if (!encoded.equals(generated)) throw new Error(`${relative} is stale. Regenerate browser images on the confirmed remote runner.`);
|
||||
} else {
|
||||
await mkdir(path.dirname(destination), { recursive: true });
|
||||
await writeFile(destination, encoded);
|
||||
}
|
||||
console.log(`${check ? "Verified" : "Generated"} ${relative}: ${original.length} → ${encoded.length} bytes (${(100 * (1 - encoded.length / original.length)).toFixed(1)}% smaller)`);
|
||||
}
|
||||
@@ -0,0 +1,66 @@
|
||||
import { useId, useState } from "react";
|
||||
import { ArchitectureFigure } from "./ArchitectureFigure";
|
||||
|
||||
type Slide = { source: string; alt: string };
|
||||
|
||||
export function FigureGallery({ slides }: { slides: Slide[] }) {
|
||||
const [active, setActive] = useState(0);
|
||||
const viewport = useId();
|
||||
const slide = slides[active];
|
||||
if (!slide) return null;
|
||||
|
||||
function move(offset: number) {
|
||||
setActive((current) => (current + offset + slides.length) % slides.length);
|
||||
}
|
||||
|
||||
return (
|
||||
<section
|
||||
className="figure-gallery"
|
||||
role="region"
|
||||
aria-roledescription="轮播"
|
||||
aria-label="文档配图"
|
||||
onKeyDown={(event) => {
|
||||
if ((event.target as HTMLElement).closest("dialog")) return;
|
||||
if (event.key === "ArrowLeft" || event.key === "ArrowRight") {
|
||||
event.preventDefault();
|
||||
move(event.key === "ArrowLeft" ? -1 : 1);
|
||||
}
|
||||
}}
|
||||
>
|
||||
<div
|
||||
id={viewport}
|
||||
role="group"
|
||||
aria-roledescription="幻灯片"
|
||||
aria-label={`第 ${active + 1} 张,共 ${slides.length} 张`}
|
||||
>
|
||||
<ArchitectureFigure key={slide.source} source={slide.source} alt={slide.alt} />
|
||||
</div>
|
||||
<div className="figure-gallery-controls">
|
||||
<button type="button" className="figure-gallery-arrow" aria-label="上一张图片" aria-controls={viewport} onClick={() => move(-1)}>
|
||||
<span aria-hidden="true">‹</span>
|
||||
</button>
|
||||
<div className="figure-gallery-dots" role="group" aria-label="选择图片">
|
||||
{slides.map((item, index) => (
|
||||
<button
|
||||
key={item.source}
|
||||
type="button"
|
||||
className="figure-gallery-dot"
|
||||
aria-label={`显示第 ${index + 1} 张图片`}
|
||||
aria-current={index === active ? "true" : undefined}
|
||||
aria-controls={viewport}
|
||||
onClick={() => setActive(index)}
|
||||
>
|
||||
<span aria-hidden="true" />
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
<button type="button" className="figure-gallery-arrow" aria-label="下一张图片" aria-controls={viewport} onClick={() => move(1)}>
|
||||
<span aria-hidden="true">›</span>
|
||||
</button>
|
||||
</div>
|
||||
<p className="sr-only" role="status" aria-live="polite" aria-atomic="true">
|
||||
第 {active + 1} 张,共 {slides.length} 张:{slide.alt}
|
||||
</p>
|
||||
</section>
|
||||
);
|
||||
}
|
||||
@@ -2,10 +2,13 @@ import type { CSSProperties } from "react";
|
||||
|
||||
// One stroke style for controls and navigation; labels carry the meaning.
|
||||
export function Icon({ name, size = 18, style }: {
|
||||
name: "search" | "arrow" | "book" | "code" | "menu" | "close";
|
||||
name: "search" | "arrow" | "book" | "code" | "menu" | "close" | "layers" | "nodes" | "chevron";
|
||||
size?: number; style?: CSSProperties;
|
||||
}) {
|
||||
const paths = {
|
||||
layers: <><path d="m12 3 9 5-9 5-9-5 9-5Zm-9 9 9 5 9-5M3 16l9 5 9-5" /></>,
|
||||
nodes: <><circle cx="5" cy="6" r="2" /><circle cx="19" cy="6" r="2" /><circle cx="12" cy="19" r="2" /><path d="M7 6h10M6 8l5 9m7-9-5 9" /></>,
|
||||
chevron: <path d="m9 5 7 7-7 7" />,
|
||||
search: <><circle cx="10.5" cy="10.5" r="6.5" /><path d="m16 16 4 4" /></>,
|
||||
arrow: <path d="M5 12h14m-6-6 6 6-6 6" />,
|
||||
book: <><path d="M12 5c-3-2-6-2-9-1v15c3-1 6-1 9 1 3-2 6-2 9-1V4c-3-1-6-1-9 1Z" /><path d="M12 5v15" /></>,
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
import Link from "next/link";
|
||||
import { useRouter } from "next/router";
|
||||
import { Icon } from "@/components/Icon";
|
||||
import { useEffect, useRef, useState, type ReactNode } from "react";
|
||||
import type { DocLink } from "@/lib/docs";
|
||||
import { collectionEntries, collectionIcon, collectionLabel, collectionTone } from "@/lib/collections";
|
||||
|
||||
|
||||
export function Brand() {
|
||||
@@ -13,10 +15,9 @@ export function Brand() {
|
||||
<i />
|
||||
</span>
|
||||
<span>
|
||||
Endor <span className="brand-divider">/</span>{" "}
|
||||
<strong>Tabularium</strong>
|
||||
</span>
|
||||
<span className="docs-badge">文档</span>
|
||||
<span className="docs-badge">Docs</span>
|
||||
</Link>
|
||||
);
|
||||
}
|
||||
@@ -32,51 +33,33 @@ export function Navigation({
|
||||
const collection = docs.find((d) => d.slug === current)?.collection;
|
||||
const scopedDocs = docs.filter((d) => d.collection === collection);
|
||||
const groups = [...new Set(scopedDocs.map((d) => d.group))];
|
||||
const collections = [...new Set(docs.map((d) => d.collection))];
|
||||
const collections = collectionEntries(docs);
|
||||
return (
|
||||
<nav aria-label="文档导航">
|
||||
<Link
|
||||
onClick={onNavigate}
|
||||
className={`nav-home ${!current ? "selected" : ""}`}
|
||||
href="/"
|
||||
>
|
||||
<Icon name="book" size={17} /> <span>资料库</span>
|
||||
</Link>
|
||||
{!current && collections.map((name) => (
|
||||
<Link
|
||||
onClick={onNavigate}
|
||||
className="nav-item"
|
||||
href={`/docs/${docs.find((d) => d.collection === name)!.slug}`}
|
||||
key={name}
|
||||
>
|
||||
{name}
|
||||
{collection ? <>
|
||||
<Link className="collection-identity" href={`/docs/${collections.find((c) => c.name === collection)!.entry.slug}`} onClick={onNavigate}>
|
||||
<Icon name={collectionIcon(collection)} size={22} /><span>{collectionLabel(collection)}</span>
|
||||
</Link>
|
||||
))}
|
||||
{collection && !groups.includes(collection) && <p className="eyebrow">{collection}</p>}
|
||||
</> : <div className="collection-identity"><Icon name="book" size={22} /><span>文档中心</span></div>}
|
||||
{!current && collections.map(({ name, entry }) => <Link
|
||||
onClick={onNavigate} className="collection-nav-link" href={`/docs/${entry.slug}`} key={name}
|
||||
><Icon name={collectionIcon(name)} size={18} /><span>{collectionLabel(name)}</span><Icon name="chevron" size={13} /></Link>)}
|
||||
{groups.map((group) => (
|
||||
<div className="nav-group" key={group}>
|
||||
<p>{group}</p>
|
||||
{scopedDocs
|
||||
.filter((d) => d.group === group)
|
||||
.map((d) => (
|
||||
<Link
|
||||
onClick={onNavigate}
|
||||
aria-current={d.slug === current ? "page" : undefined}
|
||||
className="nav-item"
|
||||
href={`/docs/${d.slug}`}
|
||||
key={d.slug}
|
||||
>
|
||||
{d.title}
|
||||
{d.draft && (
|
||||
<span className="tiny-dot" aria-label="草案" />
|
||||
)}
|
||||
</Link>
|
||||
))}
|
||||
<p>{group === collection ? "章节目录" : group}</p>
|
||||
{scopedDocs.filter((d) => d.group === group).map((d) => (
|
||||
<Link onClick={onNavigate} aria-current={d.slug === current ? "page" : undefined}
|
||||
className="nav-item" href={`/docs/${d.slug}`} key={d.slug}>
|
||||
<span>{d.slug.endsWith("/overview") ? "概览" : d.title.replace("(草案)", "").replace(/^\d+\s*·\s*/, "")}</span>
|
||||
{d.draft && <span className="tiny-dot" aria-label="草案" />}
|
||||
</Link>
|
||||
))}
|
||||
</div>
|
||||
))}
|
||||
</nav>
|
||||
);
|
||||
}
|
||||
|
||||
export function Shell({
|
||||
docs,
|
||||
current,
|
||||
@@ -86,6 +69,7 @@ export function Shell({
|
||||
current?: string;
|
||||
children: ReactNode;
|
||||
}) {
|
||||
const router = useRouter();
|
||||
const dialog = useRef<HTMLDialogElement>(null);
|
||||
const input = useRef<HTMLInputElement>(null);
|
||||
const trigger = useRef<HTMLButtonElement>(null);
|
||||
@@ -96,6 +80,7 @@ export function Shell({
|
||||
const [selected, setSelected] = useState(0);
|
||||
const [menu, setMenu] = useState(false);
|
||||
const collection = docs.find((d) => d.slug === current)?.collection;
|
||||
const collections = collectionEntries(docs);
|
||||
const results = searchDocs.filter((d) =>
|
||||
(!collection || d.collection === collection) &&
|
||||
`${d.title} ${d.description} ${d.searchText ?? ""}`
|
||||
@@ -134,18 +119,27 @@ export function Shell({
|
||||
return () => document.removeEventListener("keydown", keyboard);
|
||||
}, []);
|
||||
return (
|
||||
<>
|
||||
<div className="docs-shell" data-tone={collectionTone(collection)}>
|
||||
<a className="skip-link" href="#content">
|
||||
跳到正文
|
||||
</a>
|
||||
<header className="site-header">
|
||||
<Brand />
|
||||
<nav className="top-nav" aria-label="主导航">
|
||||
<Link href="/">资料库</Link>
|
||||
<Link href="/docs/00-endor-concepts-draft">架构设计</Link>
|
||||
<a href="https://gitea.entroia.com/Zayden-Jung/endorphin-tabularium-docs">
|
||||
仓库 ↗
|
||||
</a>
|
||||
<nav className="top-nav" aria-label="文档选择">
|
||||
<label className="collection-picker">
|
||||
<span className="picker-category">{docs.find((d) => d.slug === current)?.category ?? "全部分类"}</span>
|
||||
<span className="sr-only">选择分类与文档合集</span>
|
||||
<select value={collection ?? ""} onChange={(event) => {
|
||||
const entry = collections.find((c) => c.name === event.target.value)?.entry;
|
||||
void router.push(entry ? `/docs/${entry.slug}` : "/");
|
||||
}}>
|
||||
<option value="">文档中心</option>
|
||||
{[...new Set(docs.map((d) => d.category))].map((category) => <optgroup label={category} key={category}>
|
||||
{collections.filter((c) => c.entry.category === category).map(({name}) => <option value={name} key={name}>{collectionLabel(name)}</option>)}
|
||||
</optgroup>)}
|
||||
</select>
|
||||
<Icon name="chevron" size={13} />
|
||||
</label>
|
||||
</nav>
|
||||
<button
|
||||
ref={trigger}
|
||||
@@ -154,7 +148,7 @@ export function Shell({
|
||||
onClick={openSearch}
|
||||
>
|
||||
<Icon name="search" />
|
||||
<span>搜索文档…</span>
|
||||
<span>{collection ? `搜索${collectionLabel(collection)}…` : "搜索全部文档…"}</span>
|
||||
<kbd>⌘ K</kbd>
|
||||
</button>
|
||||
<button
|
||||
@@ -180,7 +174,7 @@ export function Shell({
|
||||
aria-expanded={menu}
|
||||
aria-controls="mobile-navigation"
|
||||
>
|
||||
<Icon name="menu" size={16} /> <span>文档目录</span>
|
||||
<Icon name={menu ? "close" : "menu"} size={16} /> <span>{collection ? collectionLabel(collection) : "全部文档"}</span>
|
||||
<span>{menu ? "−" : "+"}</span>
|
||||
</button>
|
||||
</div>
|
||||
@@ -208,7 +202,7 @@ export function Shell({
|
||||
<input
|
||||
ref={input}
|
||||
value={query}
|
||||
placeholder="搜索文档、命令或概念…"
|
||||
placeholder={collection ? `搜索${collectionLabel(collection)}的内容…` : "搜索全部文档、命令或概念…"}
|
||||
aria-label="搜索文档内容"
|
||||
aria-controls="search-results"
|
||||
onChange={(e) => {
|
||||
@@ -264,7 +258,7 @@ export function Shell({
|
||||
))}
|
||||
{!results.length && (
|
||||
<p className="empty-search">
|
||||
没有找到相关文档。试试「节点」「SVG」或「pnpm」。
|
||||
没有找到相关内容,请尝试其他关键词。
|
||||
</p>
|
||||
)}
|
||||
</div>
|
||||
@@ -272,6 +266,6 @@ export function Shell({
|
||||
↑ ↓ 选择 <span>Enter 打开 · Esc 关闭</span>
|
||||
</div>
|
||||
</dialog>
|
||||
</>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
import type { DocLink } from "@/lib/docs";
|
||||
|
||||
export function collectionLabel(name: string) {
|
||||
return name.replace(/ 文档$| 源码教程$|问题集$/g, "");
|
||||
}
|
||||
export function collectionTone(name?: string) {
|
||||
if (name?.includes("Pretext")) return "blue";
|
||||
if (name?.includes("语言设计")) return "violet";
|
||||
if (name?.includes("垃圾回收")) return "amber";
|
||||
return "green";
|
||||
}
|
||||
export function collectionIcon(name?: string): "book" | "code" | "layers" | "nodes" {
|
||||
if (name?.includes("Pretext")) return "code";
|
||||
if (name?.includes("语言设计")) return "layers";
|
||||
if (name?.includes("垃圾回收")) return "nodes";
|
||||
return "book";
|
||||
}
|
||||
export function collectionEntries(docs: DocLink[]) {
|
||||
return [...new Set(docs.map((doc) => doc.collection))].map((name) => {
|
||||
const items = docs.filter((doc) => doc.collection === name);
|
||||
const entry = items.find((doc) => doc.slug.endsWith("/overview")) ?? items[0];
|
||||
return { name, entry, count: items.length };
|
||||
});
|
||||
}
|
||||
@@ -4,20 +4,24 @@ import catalog from "../../../../content/catalog.json";
|
||||
|
||||
const directory = path.resolve(process.cwd(), "../../content/docs");
|
||||
const validSlug = /^[a-z0-9]+(?:-[a-z0-9]+)*(?:\/[a-z0-9]+(?:-[a-z0-9]+)*)*$/;
|
||||
type Metadata = { collection?: string; group?: string; description?: string; draft?: boolean; featured?: boolean };
|
||||
type Metadata = { slug?: string; category?: string; collection?: string; group?: string; description?: string; draft?: boolean; featured?: boolean };
|
||||
export type DocLink = {
|
||||
slug: string; title: string; searchText?: string;
|
||||
slug: string; sourceSlug: string; category: string; title: string; searchText?: string;
|
||||
group: string; collection: string; description: string; draft: boolean; featured: boolean;
|
||||
};
|
||||
export type Doc = DocLink & { content: string };
|
||||
|
||||
export async function readDoc(slug: string): Promise<Doc> {
|
||||
if (!validSlug.test(slug)) throw new Error("Invalid document slug");
|
||||
const content = await fs.readFile(path.join(directory, `${slug}.md`), "utf8");
|
||||
const sourceSlug = Object.entries(catalog.documents).find(([, metadata]) => metadata.slug === slug)?.[0] ?? slug;
|
||||
const content = await fs.readFile(path.join(directory, `${sourceSlug}.md`), "utf8");
|
||||
const title = content.match(/^# (.+)$/m)?.[1]?.trim() ?? slug;
|
||||
const collection = catalog.collections.find((c) => !c.path || slug.startsWith(`${c.path}/`))!;
|
||||
const metadata: Metadata = (catalog.documents as Record<string, Metadata>)[slug] ?? {};
|
||||
return { slug, title, content, searchText: content,
|
||||
const collection = catalog.collections.find((c) => !c.path || sourceSlug.startsWith(`${c.path}/`))!;
|
||||
const metadata: Metadata = (catalog.documents as Record<string, Metadata>)[sourceSlug] ?? {};
|
||||
if (!metadata.slug || !metadata.category || !validSlug.test(metadata.slug) || metadata.slug.split("/").some((part) => /^\d+-/.test(part))) {
|
||||
throw new Error(`Register a semantic slug and category in content/catalog.json: ${sourceSlug}`);
|
||||
}
|
||||
return { slug: metadata.slug, sourceSlug, category: metadata.category, title, content, searchText: content,
|
||||
group: metadata.group ?? collection.title, collection: metadata.collection ?? collection.title,
|
||||
description: metadata.description ?? collection.description,
|
||||
draft: metadata.draft ?? false, featured: metadata.featured ?? false,
|
||||
@@ -36,9 +40,11 @@ export async function listDocs(): Promise<DocLink[]> {
|
||||
}));
|
||||
return files.flat();
|
||||
}
|
||||
return Promise.all((await walk("")).sort().map(async (slug) => {
|
||||
const docs = await Promise.all((await walk("")).sort().map(async (slug) => {
|
||||
const { content: _, searchText: __, ...doc } = await readDoc(slug);
|
||||
void _; void __;
|
||||
return doc;
|
||||
}));
|
||||
if (new Set(docs.map((doc) => doc.slug)).size !== docs.length) throw new Error("Duplicate public document slug");
|
||||
return docs;
|
||||
}
|
||||
|
||||
@@ -17,7 +17,10 @@ import remarkGfm from "remark-gfm";
|
||||
import { listDocs, readDoc, type Doc, type DocLink } from "@/lib/docs";
|
||||
import { Shell, Navigation } from "@/components/Shell";
|
||||
import { ArchitectureFigure } from "@/components/ArchitectureFigure";
|
||||
import { FigureGallery } from "@/components/FigureGallery";
|
||||
import { CodeBlock } from "@/components/CodeBlock";
|
||||
import { collectionEntries, collectionLabel } from "@/lib/collections";
|
||||
import { Icon } from "@/components/Icon";
|
||||
import { headingsFor } from "@/lib/navigation";
|
||||
|
||||
type Props = { doc: Doc; docs: DocLink[] };
|
||||
@@ -49,6 +52,7 @@ export default function DocPage({
|
||||
const [active, setActive] = useState("");
|
||||
|
||||
const siblings = docs.filter((d) => d.collection === doc.collection);
|
||||
const collectionEntry = collectionEntries(docs).find((c) => c.name === doc.collection)!.entry;
|
||||
const index = siblings.findIndex((d) => d.slug === doc.slug);
|
||||
useEffect(() => {
|
||||
const observer = new IntersectionObserver(
|
||||
@@ -90,24 +94,50 @@ export default function DocPage({
|
||||
</aside>
|
||||
<main id="content" className="reading-main">
|
||||
<div className="breadcrumb">
|
||||
<Link href="/">文档</Link>
|
||||
<span>/</span>
|
||||
<span>{doc.group}</span>
|
||||
<Link href={`/docs/${collectionEntry.slug}`}>{collectionLabel(doc.collection)}</Link>
|
||||
<Icon name="chevron" size={12} />
|
||||
<span>{doc.slug === collectionEntry.slug ? "概览" : doc.group === doc.collection ? doc.title : doc.group}</span>
|
||||
{doc.draft && <span className="draft-badge">草案</span>}
|
||||
</div>
|
||||
<article className="prose prose-neutral max-w-none">
|
||||
<ReactMarkdown
|
||||
remarkPlugins={[remarkGfm]}
|
||||
components={{
|
||||
p: ({ children, node }) =>
|
||||
node?.children.some(
|
||||
a: ({ href, children }) => {
|
||||
if (!href) return <a>{children}</a>;
|
||||
let target = href;
|
||||
if (!/^(?:[a-z]+:|\/\/|#)/i.test(href)) {
|
||||
const resolved = new URL(href, `https://docs.local/docs/${doc.sourceSlug}`);
|
||||
const source = decodeURIComponent(resolved.pathname).replace(/^\/docs\//, "").replace(/\.md$/, "");
|
||||
const linked = docs.find((d) => d.sourceSlug === source || d.slug === source);
|
||||
if (linked) target = `/docs/${linked.slug}${resolved.search}${resolved.hash}`;
|
||||
}
|
||||
return <a href={target}>{children}</a>;
|
||||
},
|
||||
p: ({ children, node }) => {
|
||||
const slides = node?.children.flatMap((child) =>
|
||||
child.type === "element" && child.tagName === "img" &&
|
||||
typeof child.properties.src === "string" &&
|
||||
child.properties.src.startsWith("/figures/endor-")
|
||||
? [{ source: child.properties.src, alt: String(child.properties.alt ?? "") }]
|
||||
: [],
|
||||
) ?? [];
|
||||
const onlyImages = node?.children.every((child) =>
|
||||
(child.type === "element" && child.tagName === "img" &&
|
||||
typeof child.properties.src === "string" &&
|
||||
child.properties.src.startsWith("/figures/endor-")) ||
|
||||
(child.type === "text" && child.value.trim() === ""),
|
||||
);
|
||||
if (slides.length > 1 && onlyImages) return <FigureGallery slides={slides} />;
|
||||
return node?.children.some(
|
||||
(child) =>
|
||||
child.type === "element" && child.tagName === "img",
|
||||
) ? (
|
||||
<div>{children}</div>
|
||||
) : (
|
||||
<p>{children}</p>
|
||||
),
|
||||
);
|
||||
},
|
||||
img: ({ src, alt }) =>
|
||||
typeof src === "string" && src.startsWith("/figures/endor-") ? (
|
||||
<ArchitectureFigure source={src} alt={alt ?? "Endor 架构图"} />
|
||||
@@ -198,7 +228,7 @@ export default function DocPage({
|
||||
<div className="article-end">
|
||||
|
||||
<a
|
||||
href={`https://gitea.entroia.com/Zayden-Jung/endorphin-tabularium-docs/src/branch/main/content/docs/${doc.slug}.md`}
|
||||
href={`https://gitea.entroia.com/Zayden-Jung/endorphin-tabularium-docs/src/branch/main/content/docs/${doc.sourceSlug}.md`}
|
||||
>
|
||||
查看文档源码 ↗
|
||||
</a>
|
||||
@@ -210,10 +240,7 @@ export default function DocPage({
|
||||
<strong>{siblings[index - 1].title}</strong>
|
||||
</Link>
|
||||
) : (
|
||||
<Link href="/">
|
||||
<small>← 返回</small>
|
||||
<strong>文档概览</strong>
|
||||
</Link>
|
||||
<span />
|
||||
)}
|
||||
{index < siblings.length - 1 && (
|
||||
<Link
|
||||
|
||||
@@ -5,6 +5,7 @@ import { useState } from "react";
|
||||
import { listDocs, type DocLink } from "@/lib/docs";
|
||||
import { Shell, Navigation } from "@/components/Shell";
|
||||
import { Icon } from "@/components/Icon";
|
||||
import { collectionEntries, collectionIcon, collectionLabel, collectionTone } from "@/lib/collections";
|
||||
|
||||
export const getStaticProps: GetStaticProps<{ docs: DocLink[] }> = async () => ({
|
||||
props: { docs: await listDocs() },
|
||||
@@ -17,7 +18,7 @@ export default function Home({ docs }: InferGetStaticPropsType<typeof getStaticP
|
||||
const collections = [...new Set(docs.map((doc) => doc.collection))];
|
||||
const filtered = docs.filter((doc) => (!collection || doc.collection === collection) &&
|
||||
`${doc.title} ${doc.description}`.toLocaleLowerCase().includes(query.trim().toLocaleLowerCase()));
|
||||
const featured = docs.filter((doc) => doc.featured).slice(0, 3);
|
||||
const entries = collectionEntries(docs);
|
||||
return <>
|
||||
<Head><title>Tabularium · 资料库</title><meta name="description" content="Endor 文档、源码研究与学习资料。" /></Head>
|
||||
<Shell docs={docs}>
|
||||
@@ -25,16 +26,16 @@ export default function Home({ docs }: InferGetStaticPropsType<typeof getStaticP
|
||||
<aside className="sidebar"><Navigation docs={docs} /></aside>
|
||||
<main id="content" className="home-main">
|
||||
<section className="library-intro">
|
||||
<h1>资料库</h1>
|
||||
<h1>文档中心</h1>
|
||||
<p>系统设计、源码研究与学习笔记。</p>
|
||||
</section>
|
||||
<section className="featured-section" aria-labelledby="featured-title">
|
||||
<h2 id="featured-title">推荐阅读</h2>
|
||||
<div className="featured-grid">{featured.map((doc) => <Link className="featured-link" href={`/docs/${doc.slug}`} key={doc.slug}>
|
||||
<Icon name={doc.collection === "Endor 文档" ? "book" : "code"} size={23} />
|
||||
<h3>{doc.title.replace("(草案)", "")}</h3>
|
||||
<p>{doc.description}</p>
|
||||
<Icon name="arrow" />
|
||||
<h2 id="featured-title">选择一份文档</h2>
|
||||
<div className="featured-grid">{entries.map(({ name, entry, count }) => <Link className="featured-link" data-tone={collectionTone(name)} href={`/docs/${entry.slug}`} key={name}>
|
||||
<span className="collection-art"><Icon name={collectionIcon(name)} size={26} /></span>
|
||||
<h3>{collectionLabel(name)}</h3>
|
||||
<p>{entry.description}</p>
|
||||
<span className="collection-entry">{count} 篇 <Icon name="arrow" size={17} /></span>
|
||||
</Link>)}</div>
|
||||
</section>
|
||||
<section className="library-section" id="library" aria-labelledby="library-title">
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
import { NextResponse, type NextRequest } from "next/server";
|
||||
import { authConfig, SESSION_COOKIE, validSession } from "./lib/auth";
|
||||
import catalog from "../../../content/catalog.json";
|
||||
|
||||
const legacyRoutes = new Map(Object.entries(catalog.documents).map(([source, metadata]) => [
|
||||
`/docs/${source}`, `/docs/${metadata.slug}`,
|
||||
]));
|
||||
|
||||
export function proxy(request: NextRequest) {
|
||||
const path = request.nextUrl.pathname;
|
||||
@@ -49,6 +54,13 @@ export function proxy(request: NextRequest) {
|
||||
);
|
||||
}
|
||||
}
|
||||
// Keep legacy URLs behind authentication and out of static generation.
|
||||
const destination = legacyRoutes.get(path);
|
||||
if (destination && ["GET", "HEAD"].includes(request.method)) {
|
||||
const target = request.nextUrl.clone();
|
||||
target.pathname = destination;
|
||||
return NextResponse.redirect(target, { status: 308, headers });
|
||||
}
|
||||
return NextResponse.next({ headers });
|
||||
}
|
||||
if (path.startsWith("/api/") || !["GET", "HEAD"].includes(request.method)) {
|
||||
|
||||
@@ -55,7 +55,7 @@ button {
|
||||
}
|
||||
.site-header {
|
||||
height: 68px;
|
||||
border-bottom: 1px solid var(--line);
|
||||
border: 0;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
padding: 0 32px;
|
||||
@@ -82,9 +82,9 @@ button {
|
||||
color: #c8ceca;
|
||||
}
|
||||
.docs-badge {
|
||||
font-size: 10px;
|
||||
font-size: 13px;
|
||||
padding: 2px 5px;
|
||||
border: 1px solid var(--line);
|
||||
border: 0;
|
||||
border-radius: 4px;
|
||||
color: var(--muted);
|
||||
letter-spacing: 0;
|
||||
@@ -123,7 +123,7 @@ button {
|
||||
display: flex;
|
||||
gap: 9px;
|
||||
align-items: center;
|
||||
border: 1px solid #e2e7e3;
|
||||
border: 0;
|
||||
background: #fafbf9;
|
||||
border-radius: 7px;
|
||||
padding: 7px 10px;
|
||||
@@ -138,7 +138,7 @@ button {
|
||||
}
|
||||
.search-trigger kbd {
|
||||
margin-left: auto;
|
||||
border: 1px solid var(--line);
|
||||
border: 0;
|
||||
border-radius: 3px;
|
||||
padding: 0 4px;
|
||||
font-size: 10px;
|
||||
@@ -163,7 +163,7 @@ button {
|
||||
grid-template-columns: 238px minmax(0, 1fr);
|
||||
}
|
||||
.sidebar {
|
||||
border-right: 1px solid var(--line);
|
||||
border: 0;
|
||||
padding: 32px 22px;
|
||||
height: calc(100dvh - 68px);
|
||||
position: sticky;
|
||||
@@ -200,7 +200,7 @@ button {
|
||||
padding: 9px 10px;
|
||||
line-height: 1.6;
|
||||
color: #637066;
|
||||
border-left: 1px solid var(--line);
|
||||
border: 0;
|
||||
margin-left: 10px;
|
||||
}
|
||||
.nav-item:hover {
|
||||
@@ -225,9 +225,9 @@ button {
|
||||
padding: 0 48px;
|
||||
}
|
||||
.eyebrow { font-size: 13px; font-weight: 500; color: var(--muted); margin: 0; }
|
||||
.draft-badge { color: #8c733e; background: #faf6e9; border: 1px solid #eee4c9; border-radius: 4px; padding: 2px 6px; font-size: 12px; white-space: nowrap; }
|
||||
.draft-badge { color: #8c733e; background: #faf6e9; border: 0; border-radius: 4px; padding: 2px 6px; font-size: 12px; white-space: nowrap; }
|
||||
.site-footer {
|
||||
border-top: 1px solid var(--line);
|
||||
border: 0;
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
gap: 15px;
|
||||
@@ -324,7 +324,7 @@ button {
|
||||
SFMono-Regular,
|
||||
Consolas,
|
||||
monospace;
|
||||
border: 1px solid #e7ece7;
|
||||
border: 0;
|
||||
background: #f6f8f5;
|
||||
border-radius: 4px;
|
||||
padding: 2px 5px;
|
||||
@@ -344,7 +344,7 @@ button {
|
||||
min-width: 360px;
|
||||
margin: 0;
|
||||
font-size: 13px;
|
||||
border: 1px solid var(--line);
|
||||
border: 0;
|
||||
border-radius: 7px;
|
||||
}
|
||||
.prose thead {
|
||||
@@ -357,7 +357,7 @@ button {
|
||||
min-width: 100px;
|
||||
}
|
||||
.prose img {
|
||||
border: 1px solid var(--line);
|
||||
border: 0;
|
||||
border-radius: 8px;
|
||||
padding: 12px;
|
||||
background: #fafbf8;
|
||||
@@ -366,7 +366,7 @@ button {
|
||||
.callout {
|
||||
display: flex;
|
||||
gap: 12px;
|
||||
border: 1px solid #e2e9e0;
|
||||
border: 0;
|
||||
padding: 15px 18px;
|
||||
border-radius: 7px;
|
||||
background: #f8faf6;
|
||||
@@ -392,7 +392,7 @@ button {
|
||||
font-size: 16px;
|
||||
}
|
||||
.code-block {
|
||||
border: 1px solid #e1e7e0;
|
||||
border: 0;
|
||||
border-radius: 8px;
|
||||
overflow: hidden;
|
||||
background: #f9fbf7;
|
||||
@@ -404,7 +404,7 @@ button {
|
||||
justify-content: space-between;
|
||||
align-items: center;
|
||||
padding: 10px 15px;
|
||||
border-bottom: 1px solid #e7ece4;
|
||||
border: 0;
|
||||
color: #879781;
|
||||
font:
|
||||
10px ui-monospace,
|
||||
@@ -415,7 +415,7 @@ button {
|
||||
}
|
||||
.code-toolbar button {
|
||||
padding: 2px 6px;
|
||||
border: 1px solid #dce5d6;
|
||||
border: 0;
|
||||
border-radius: 4px;
|
||||
font-size: 11px;
|
||||
min-height: 28px;
|
||||
@@ -472,13 +472,13 @@ button {
|
||||
margin-bottom: 18px;
|
||||
}
|
||||
.toc nav {
|
||||
border-left: 1px solid var(--line);
|
||||
border: 0;
|
||||
}
|
||||
.toc nav a {
|
||||
display: block;
|
||||
padding: 7px 0 7px 15px;
|
||||
margin-left: -1px;
|
||||
border-left: 1px solid transparent;
|
||||
border: 0;
|
||||
color: #69766b;
|
||||
line-height: 1.6;
|
||||
}
|
||||
@@ -494,7 +494,7 @@ button {
|
||||
display: flex;
|
||||
gap: 15px;
|
||||
justify-content: space-between;
|
||||
border-top: 1px solid var(--line);
|
||||
border: 0;
|
||||
padding: 25px 0;
|
||||
margin-top: 45px;
|
||||
font-size: 10px;
|
||||
@@ -510,7 +510,7 @@ button {
|
||||
margin: 10px 0 45px;
|
||||
}
|
||||
.pagination > a {
|
||||
border: 1px solid var(--line);
|
||||
border: 0;
|
||||
padding: 18px;
|
||||
border-radius: 7px;
|
||||
}
|
||||
@@ -533,7 +533,7 @@ button {
|
||||
}
|
||||
.search-dialog {
|
||||
padding: 0;
|
||||
border: 1px solid var(--line);
|
||||
border: 0;
|
||||
border-radius: 12px;
|
||||
width: min(570px, calc(100vw - 32px));
|
||||
max-height: 80dvh;
|
||||
@@ -550,7 +550,7 @@ button {
|
||||
align-items: center;
|
||||
gap: 13px;
|
||||
padding: 17px;
|
||||
border-bottom: 1px solid var(--line);
|
||||
border: 0;
|
||||
}
|
||||
.search-input-row > span {
|
||||
font-size: 25px;
|
||||
@@ -564,7 +564,7 @@ button {
|
||||
}
|
||||
.search-input-row button {
|
||||
font-size: 10px;
|
||||
border: 1px solid var(--line);
|
||||
border: 0;
|
||||
border-radius: 4px;
|
||||
padding: 3px 5px;
|
||||
}
|
||||
@@ -578,7 +578,7 @@ button {
|
||||
}
|
||||
.search-result {
|
||||
display: block;
|
||||
border: 1px solid transparent;
|
||||
border: 0;
|
||||
padding: 13px;
|
||||
border-radius: 7px;
|
||||
}
|
||||
@@ -612,7 +612,7 @@ button {
|
||||
}
|
||||
.search-footer {
|
||||
padding: 12px 20px;
|
||||
border-top: 1px solid var(--line);
|
||||
border: 0;
|
||||
font-size: 10px;
|
||||
color: #9da797;
|
||||
display: flex;
|
||||
@@ -656,7 +656,7 @@ button {
|
||||
.mobile-toc {
|
||||
display: block;
|
||||
margin: 18px 0;
|
||||
border: 1px solid var(--line);
|
||||
border: 0;
|
||||
border-radius: 6px;
|
||||
padding: 10px 15px;
|
||||
font-size: 12px;
|
||||
@@ -699,7 +699,7 @@ button {
|
||||
top: 62px;
|
||||
z-index: 25;
|
||||
background: #fff;
|
||||
border-bottom: 1px solid var(--line);
|
||||
border: 0;
|
||||
}
|
||||
.mobile-bar button {
|
||||
display: flex;
|
||||
@@ -716,7 +716,7 @@ button {
|
||||
.mobile-navigation {
|
||||
display: block;
|
||||
padding: 15px 22px;
|
||||
border-bottom: 1px solid var(--line);
|
||||
border: 0;
|
||||
max-height: 65dvh;
|
||||
overflow: auto;
|
||||
}
|
||||
@@ -833,6 +833,7 @@ button {
|
||||
*,
|
||||
*::before,
|
||||
*::after {
|
||||
animation: none !important;
|
||||
transition: none !important;
|
||||
}
|
||||
}
|
||||
@@ -852,7 +853,7 @@ button {
|
||||
|
||||
.table-scroll {
|
||||
overflow-x: auto;
|
||||
border: 1px solid var(--line);
|
||||
border: 0;
|
||||
border-radius: 7px;
|
||||
margin: 24px 0;
|
||||
}
|
||||
@@ -881,6 +882,57 @@ button {
|
||||
border-radius: 0;
|
||||
background: transparent;
|
||||
}
|
||||
.figure-gallery {
|
||||
margin: 28px 0;
|
||||
}
|
||||
.figure-gallery .architecture-preview {
|
||||
margin: 0;
|
||||
}
|
||||
.figure-gallery-controls,
|
||||
.figure-gallery-dots {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
}
|
||||
.figure-gallery-controls {
|
||||
gap: 20px;
|
||||
margin-top: 12px;
|
||||
}
|
||||
.figure-gallery-arrow,
|
||||
.figure-gallery-dot {
|
||||
display: grid;
|
||||
place-items: center;
|
||||
min-width: 36px;
|
||||
min-height: 36px;
|
||||
padding: 0;
|
||||
border: 0;
|
||||
border-radius: 50%;
|
||||
color: #57534e;
|
||||
background: transparent;
|
||||
cursor: pointer;
|
||||
}
|
||||
.figure-gallery-arrow {
|
||||
font-size: 28px;
|
||||
line-height: 1;
|
||||
}
|
||||
.figure-gallery-dot span {
|
||||
width: 7px;
|
||||
height: 7px;
|
||||
border-radius: 50%;
|
||||
background: #d6d3d1;
|
||||
}
|
||||
.figure-gallery-dot[aria-current="true"] span {
|
||||
background: #2563eb;
|
||||
}
|
||||
.figure-gallery-arrow:hover,
|
||||
.figure-gallery-dot:hover {
|
||||
background: #f5f5f4;
|
||||
}
|
||||
.figure-gallery-arrow:focus-visible,
|
||||
.figure-gallery-dot:focus-visible {
|
||||
outline: 2px solid #2563eb;
|
||||
outline-offset: 2px;
|
||||
}
|
||||
.image-lightbox {
|
||||
width: 100vw;
|
||||
height: 100dvh;
|
||||
@@ -981,7 +1033,7 @@ button {
|
||||
.auth-card {
|
||||
width: min(390px, calc(100vw - 40px));
|
||||
padding: 36px;
|
||||
border: 1px solid var(--line);
|
||||
border: 0;
|
||||
border-radius: 12px;
|
||||
background: white;
|
||||
box-shadow: 0 15px 45px #34523c06;
|
||||
@@ -1007,7 +1059,7 @@ button {
|
||||
.auth-card input {
|
||||
width: 100%;
|
||||
padding: 13px;
|
||||
border: 1px solid #d8e2d7;
|
||||
border: 0;
|
||||
border-radius: 6px;
|
||||
font:
|
||||
24px ui-monospace,
|
||||
@@ -1060,7 +1112,7 @@ button {
|
||||
.library-intro p { margin: 0; font-size: 16px; color: var(--muted); }
|
||||
.featured-section h2, .library-section h2 { font-size: 19px; font-weight: 550; margin: 0 0 22px; }
|
||||
.featured-grid { display: grid; grid-template-columns: repeat(auto-fit, minmax(min(100%, 240px), 1fr)); gap: 20px; }
|
||||
.featured-link { position: relative; border: 1px solid var(--line); border-radius: 8px; padding: 26px; }
|
||||
.featured-link { position: relative; border: 0; border-radius: 8px; padding: 26px; }
|
||||
.featured-link:hover { border-color: #a4b7aa; background: #fafcfb; }
|
||||
.featured-link > svg:first-child { color: var(--green); margin-bottom: 18px; }
|
||||
.featured-link h3 { font-size: 18px; font-weight: 550; line-height: 1.6; margin: 0 0 10px; padding-right: 18px; }
|
||||
@@ -1071,11 +1123,11 @@ button {
|
||||
.collection-filters { display: flex; gap: 6px; flex-wrap: wrap; }
|
||||
.collection-filters button { font-size: 14px; padding: 8px 12px; border-radius: 5px; color: var(--muted); }
|
||||
.collection-filters button[aria-pressed="true"] { background: #eef4f0; color: var(--green); }
|
||||
.library-search { display: flex; align-items: center; gap: 8px; color: var(--muted); border: 1px solid var(--line); border-radius: 6px; padding: 9px 12px; }
|
||||
.library-search { display: flex; align-items: center; gap: 8px; color: var(--muted); border: 0; border-radius: 6px; padding: 9px 12px; }
|
||||
.library-search input { min-width: 0; width: 145px; outline: 0; font-size: 14px; }
|
||||
.library-search:focus-within { border-color: var(--green); }
|
||||
.library-list { padding: 0; margin: 0; list-style: none; border-top: 1px solid var(--line); }
|
||||
.library-list li { border-bottom: 1px solid var(--line); }
|
||||
.library-list { padding: 0; margin: 0; list-style: none; border: 0; }
|
||||
.library-list li { border: 0; }
|
||||
.library-list a { display: flex; align-items: center; gap: 18px; padding: 20px 4px; }
|
||||
.library-list a:hover { color: var(--green); background: #fafcfb; }
|
||||
.library-row-title { flex: 1; font-size: 15px; line-height: 1.7; }
|
||||
@@ -1105,3 +1157,198 @@ button {
|
||||
.site-footer { font-size: 13px; }
|
||||
}
|
||||
.search-status { padding: 12px 20px 0; font-size: 13px; color: var(--muted); }
|
||||
|
||||
/* Shared typography; each document keeps its own identity and reading context. */
|
||||
:root { --ink: #202724; --muted: #707873; --green: #27745b; --accent-wash: #e9f2ec; --ease: cubic-bezier(.2,.7,.2,1); }
|
||||
body { background: #fdfefd; }
|
||||
svg { flex-shrink: 0; }
|
||||
[data-tone="blue"] { --green: #456da2; --accent-wash: #eaf0f9; }
|
||||
[data-tone="violet"] { --green: #79609e; --accent-wash: #f1ecf8; }
|
||||
[data-tone="amber"] { --green: #927346; --accent-wash: #f6f0e6; }
|
||||
.site-header { height: 64px; padding: 0 30px; gap: 32px; border-bottom: 1px solid #edf0ee; background: #fdfefded; backdrop-filter: blur(18px); }
|
||||
.brand { gap: 10px; }
|
||||
.brand-mark i { background: linear-gradient(160deg,#80b69a,#27745b); }
|
||||
.docs-badge { color: #819087; padding: 0; font-size: 13px; }
|
||||
.top-nav { align-self: stretch; align-items: stretch; gap: 26px; margin-left: 16px; }
|
||||
.top-nav a, .top-nav a:nth-child(2) { display: flex; align-items: center; position: relative; white-space: nowrap; transition: color 180ms; }
|
||||
.top-nav a::after { content: ""; position: absolute; left: 0; right: 0; bottom: 0; height: 2px; background: var(--green); transform: scaleX(0); transform-origin: left; transition: transform 220ms var(--ease); }
|
||||
.top-nav a:hover, .top-nav a[aria-current="page"] { color: var(--ink); }
|
||||
.top-nav a[aria-current="page"]::after { transform: scaleX(1); }
|
||||
.search-trigger { margin-left: auto; width: 218px; padding: 8px 12px; background: #f0f3f1; color: #768078; transition: background 180ms,box-shadow 180ms; }
|
||||
.search-trigger:hover { background: #eaf0ec; box-shadow: 0 3px 16px #1c3c2810; }
|
||||
.search-trigger span { overflow: hidden; white-space: nowrap; text-overflow: ellipsis; }
|
||||
.search-trigger kbd { background: transparent; font-size: 11px; white-space: nowrap; }
|
||||
.logout-button { font-size: 12px; }
|
||||
.home-layout { grid-template-columns: 272px minmax(0,1fr); }
|
||||
.reading-layout { grid-template-columns: 272px minmax(0,1fr) 222px; }
|
||||
.sidebar { padding: 30px 26px 40px; height: calc(100dvh - 64px); top: 64px; scrollbar-width: thin; scrollbar-color: #d9e2dc transparent; }
|
||||
.nav-back { display: inline-flex; align-items: center; gap: 8px; font-size: 12px; color: #8a948e; margin: 0 8px 28px; transition: color 160ms; }
|
||||
.nav-back:hover { color: var(--green); }
|
||||
.collection-identity { display: flex; gap: 12px; align-items: center; color: var(--green); font-size: 16px; font-weight: 550; margin: 0 8px 28px; line-height: 1.5; }
|
||||
.collection-nav-link { display: flex; align-items: center; gap: 12px; padding: 12px 10px; margin-bottom: 6px; border-radius: 7px; color: #647169; transition: background 180ms,color 180ms; }
|
||||
.collection-nav-link svg:last-child { margin-left: auto; opacity: 0; transform: translateX(-3px); transition: opacity 180ms,transform 180ms; }
|
||||
.collection-nav-link:hover { background: #f0f5f1; color: var(--green); }
|
||||
.collection-nav-link:hover svg:last-child { opacity: 1; transform: none; }
|
||||
.nav-group { margin-top: 28px; }
|
||||
.nav-group > p { font-size: 12px; font-weight: 500; color: #909991; margin: 0 10px 10px; }
|
||||
.nav-item { position: relative; padding: 8px 10px; margin: 2px 0; border-radius: 5px; line-height: 1.65; color: #68756d; transition: color 160ms,background 160ms; }
|
||||
.nav-item:hover { color: var(--green); background: color-mix(in srgb,var(--accent-wash) 45%,transparent); }
|
||||
.nav-item[aria-current="page"] { color: var(--green); background: linear-gradient(90deg,var(--accent-wash),transparent); }
|
||||
.nav-item[aria-current="page"]::before { content: ""; position: absolute; left: -3px; top: 10px; bottom: 10px; width: 2px; border-radius: 2px; background: var(--green); }
|
||||
.home-main { max-width: 1160px; }
|
||||
.library-intro { position: relative; padding: 68px 0 46px; isolation: isolate; }
|
||||
.library-intro::before { content: ""; position: absolute; z-index: -1; width: 420px; max-width: 100%; height: 240px; top: 0; left: -30px; background: radial-gradient(ellipse at 30% 30%,#eaf3ed99,transparent 70%); pointer-events: none; }
|
||||
.library-intro h1 { font-weight: 550; }
|
||||
.featured-grid { grid-template-columns: repeat(auto-fit,minmax(min(100%,220px),1fr)); }
|
||||
.featured-link { display: flex; flex-direction: column; padding: 24px; border-radius: 12px; background: linear-gradient(145deg,color-mix(in srgb,var(--accent-wash) 65%,white),#fbfcfb 65%); transition: transform 240ms var(--ease),box-shadow 240ms var(--ease); }
|
||||
.featured-link:hover { background: linear-gradient(145deg,var(--accent-wash),#fbfcfb 80%); transform: translateY(-4px); box-shadow: 0 14px 36px #1d35220d; }
|
||||
.collection-art { display: grid; place-items: center; width: 44px; height: 44px; border-radius: 12px; color: var(--green); background: linear-gradient(145deg,#ffffffc9,var(--accent-wash)); margin-bottom: 26px; box-shadow: 0 2px 8px #25483705; transition: transform 240ms var(--ease); }
|
||||
.featured-link:hover .collection-art { transform: translateY(-2px) rotate(-4deg); }
|
||||
.featured-link h3 { font-size: 19px; margin: 0 0 12px; padding: 0; }
|
||||
.featured-link p { flex: 1; }
|
||||
.collection-entry { display: flex; align-items: center; justify-content: space-between; margin-top: 28px; color: var(--green); font-size: 13px; }
|
||||
.collection-entry svg { transition: transform 200ms var(--ease); }
|
||||
.featured-link:hover .collection-entry svg { transform: translateX(4px); }
|
||||
.collection-filters { gap: 4px; }
|
||||
.collection-filters button { font-size: 13px; transition: background 180ms,color 180ms; }
|
||||
.collection-filters button:hover { color: var(--green); background: #f0f4f1; }
|
||||
.collection-filters button[aria-pressed="true"] { background: linear-gradient(120deg,var(--accent-wash),#f2f6f3); }
|
||||
.library-search { background: #f1f4f2; }
|
||||
.library-search:focus-within { box-shadow: 0 0 0 2px var(--accent-wash); }
|
||||
.library-list a { padding: 19px 14px; border-radius: 7px; transition: background 180ms,color 180ms; }
|
||||
.library-list a:hover { background: #f2f6f3; }
|
||||
.library-row-title { font-size: 14px; }
|
||||
.library-row-group { font-size: 12px; color: #929b95; }
|
||||
.library-list svg { transition: transform 180ms; }
|
||||
.library-list a:hover svg { transform: translateX(3px); }
|
||||
.site-footer { padding: 32px 0; font-size: 12px; color: #919a94; }
|
||||
.reading-main { max-width: 852px; padding: 38px 44px 0; }
|
||||
.breadcrumb { align-items: center; flex-wrap: wrap; font-size: 12px; margin-bottom: 30px; line-height: 1.7; }
|
||||
.breadcrumb a { color: #6c7970; }
|
||||
.breadcrumb > span:not(.draft-badge) { max-width: 100%; }
|
||||
.draft-badge { font-size: 11px; background: #f7f2e9; }
|
||||
.prose { line-height: 1.9; --tw-prose-links: var(--green); }
|
||||
.prose > p:first-of-type { font-size: 17px; color: #788379; }
|
||||
.prose code:not(pre code) { background: #eef2ef; }
|
||||
.prose tbody tr, .prose thead tr { border: 0; }
|
||||
.prose tbody tr:nth-child(even) { background: #f6f8f6; }
|
||||
.prose thead { background: #eef3ef; }
|
||||
.prose img { background: transparent; padding: 0; }
|
||||
.callout { padding: 18px 20px; font-size: 14px; background: linear-gradient(120deg,#eef4ef,#f8faf7); }
|
||||
.callout-draft { background: linear-gradient(120deg,#f7f1e7,#fcfaf5); }
|
||||
.code-block { background: #f2f5f2; }
|
||||
.code-toolbar { font-size: 12px; background: #eaf0eb88; }
|
||||
.code-toolbar button { font-size: 12px; background: #ffffffaa; transition: background 180ms; }
|
||||
.code-toolbar button:hover { background: white; }
|
||||
.toc { top: 64px; height: calc(100dvh - 64px); padding: 44px 24px 30px 12px; font-size: 12px; }
|
||||
.toc > .eyebrow { font-size: 12px; color: #929c94; }
|
||||
.toc nav a { padding: 7px 10px; margin: 0; border-radius: 4px; color: #8a968d; transition: color 160ms,background 160ms; }
|
||||
.toc nav a:hover, .toc nav a.active { color: var(--green); background: linear-gradient(90deg,var(--accent-wash),transparent); }
|
||||
.article-end { margin-top: 30px; font-size: 12px; }
|
||||
.pagination > a { background: #f3f6f3; transition: background 180ms,transform 180ms var(--ease); }
|
||||
.pagination > a:hover { background: var(--accent-wash); transform: translateY(-2px); }
|
||||
.pagination small { font-size: 12px; }
|
||||
.search-dialog { background: #fdfefd; box-shadow: 0 24px 90px #192d2330; }
|
||||
.search-dialog[open] { animation: surface-in 180ms var(--ease); }
|
||||
.search-dialog::backdrop { backdrop-filter: blur(5px); }
|
||||
.search-input-row { background: #f3f6f3; padding: 20px; }
|
||||
.search-result.selected, .search-result:hover { background: var(--accent-wash); }
|
||||
.search-result > span, .search-result small { font-size: 12px; }
|
||||
.auth-page { background: radial-gradient(ellipse at 50% 30%,#edf5ef,transparent 60%),#fbfdfb; }
|
||||
.auth-card { box-shadow: 0 18px 64px #294d340b; }
|
||||
.auth-card input { background: #eff4ef; }
|
||||
.auth-card button[type="submit"] { background: linear-gradient(120deg,#3e8969,#2c7057); }
|
||||
@keyframes surface-in { from { opacity: 0; transform: translateY(5px); } to { opacity: 1; transform: none; } }
|
||||
.reading-main, .library-intro { animation: surface-in 320ms var(--ease) both; }
|
||||
@media (max-width: 1200px) {
|
||||
.site-header { gap: 22px; padding: 0 24px; }
|
||||
.top-nav { gap: 18px; margin-left: 0; }
|
||||
.search-trigger { width: 180px; }
|
||||
.reading-layout { grid-template-columns: 248px minmax(0,1fr); }
|
||||
.home-layout { grid-template-columns: 248px minmax(0,1fr); }
|
||||
.sidebar { padding-left: 22px; padding-right: 22px; }
|
||||
.toc { display: none; }
|
||||
.home-main { padding: 0 36px; }
|
||||
.mobile-toc { display: block; background: #f3f6f3; }
|
||||
}
|
||||
@media (min-width: 761px) and (max-width: 980px) {
|
||||
.top-nav { display: flex; gap: 14px; font-size: 12px; }
|
||||
.search-trigger { width: 36px; height: 34px; padding: 8px; justify-content: center; }
|
||||
.search-trigger span, .search-trigger kbd { display: none; }
|
||||
.mobile-bar, .mobile-navigation { display: none; }
|
||||
.sidebar { display: block; }
|
||||
}
|
||||
@media (max-width: 760px) {
|
||||
html { scroll-padding-top: 165px; }
|
||||
.site-header { height: auto; padding: 0 20px; column-gap: 18px; row-gap: 0; flex-wrap: wrap; }
|
||||
.brand { height: 62px; font-size: 15px; }
|
||||
.top-nav { display: flex; order: 4; width: 100%; overflow-x: auto; gap: 24px; min-width: 0; margin: 0; height: 44px; flex: 0 0 100%; font-size: 13px; scrollbar-width: none; }
|
||||
.top-nav a { padding: 0; }
|
||||
.search-trigger { width: 36px; height: 34px; padding: 8px; justify-content: center; }
|
||||
.search-trigger span, .search-trigger kbd { display: none; }
|
||||
.home-layout, .reading-layout { grid-template-columns: 1fr; }
|
||||
.sidebar { display: none; }
|
||||
.mobile-bar { display: block; top: 106px; background: #fdfefdf0; backdrop-filter: blur(14px); }
|
||||
.mobile-bar button { font-size: 13px; color: var(--green); }
|
||||
.mobile-navigation { padding: 20px 22px; background: #f7faf7; box-shadow: 0 16px 24px #26382c08; }
|
||||
.mobile-navigation .collection-identity, .mobile-navigation .nav-back { margin-bottom: 20px; }
|
||||
.home-main { padding: 0 24px; }
|
||||
.library-intro { padding: 40px 0 34px; }
|
||||
.library-intro h1 { font-size: 32px; }
|
||||
.reading-main { padding: 26px 24px 0; }
|
||||
.prose h1 { font-size: 29px; }
|
||||
.breadcrumb { margin-bottom: 24px; }
|
||||
}
|
||||
@media (max-width: 520px) {
|
||||
.featured-grid { grid-template-columns: 1fr; }
|
||||
.featured-link { padding: 23px; }
|
||||
.library-section { padding-top: 38px; }
|
||||
.library-list a { padding: 16px 8px; }
|
||||
.prose > p:first-of-type { font-size: 16px; }
|
||||
.pagination strong { font-size: 13px; }
|
||||
.site-footer { font-size: 12px; }
|
||||
}
|
||||
@media (prefers-reduced-motion: reduce) {
|
||||
html { scroll-behavior: auto; }
|
||||
*, *::before, *::after { animation: none !important; transition: none !important; }
|
||||
.featured-link:hover, .featured-link:hover .collection-art, .pagination > a:hover { transform: none; }
|
||||
}
|
||||
|
||||
/* Compact navigation and local font roles, with no font downloads. */
|
||||
:root {
|
||||
--font-reading: "Charter", "Iowan Old Style", "Songti SC", "STSong", "Noto Serif CJK SC", serif;
|
||||
--font-code: "SFMono-Regular", Consolas, "Liberation Mono", "PingFang SC", monospace;
|
||||
}
|
||||
.collection-picker { display: flex; flex-wrap: wrap; align-items: center; position: relative; min-width: 180px; max-width: 280px; }
|
||||
.collection-picker select { appearance: none; width: 100%; cursor: pointer; padding: 8px 30px 8px 12px; border: 1px solid var(--line); border-radius: 6px; background: var(--soft); font: inherit; font-size: 13px; color: var(--ink); text-overflow: ellipsis; }
|
||||
.picker-category { width: 100%; font-size: 10px; line-height: 1.4; color: var(--muted); margin-bottom: 2px; }
|
||||
.collection-picker > svg { position: absolute; right: 10px; bottom: 12px; pointer-events: none; transform: rotate(90deg); color: var(--muted); }
|
||||
.collection-picker select:focus-visible { outline: 2px solid var(--green); outline-offset: 3px; }
|
||||
.top-nav { margin-left: 0; }
|
||||
.sidebar { padding: 22px 16px 32px; }
|
||||
.collection-identity { font-size: 14px; gap: 9px; margin: 0 8px 20px; }
|
||||
.collection-identity svg { width: 18px; height: 18px; }
|
||||
.nav-group { margin-top: 20px; }
|
||||
.nav-group > p { margin: 0 8px 6px; font-size: 11px; letter-spacing: .02em; color: #7d8981; }
|
||||
.nav-item { font-size: 13px; padding: 5px 8px; margin: 0; line-height: 1.5; gap: 6px; }
|
||||
.nav-item[aria-current="page"]::before { top: 7px; bottom: 7px; }
|
||||
.collection-nav-link { padding: 7px 8px; margin-bottom: 2px; gap: 9px; font-size: 13px; }
|
||||
.prose { font-family: var(--font-reading); font-size: 16px; line-height: 1.95; }
|
||||
.prose :is(h1,h2,h3,h4), .prose table, .code-toolbar, .mobile-toc { font-family: var(--font-sans); }
|
||||
.prose :is(h1,h2,h3) { font-weight: 600; letter-spacing: -.025em; }
|
||||
.prose :is(code,pre), .code-block pre, kbd { font-family: var(--font-code); font-variant-ligatures: none; }
|
||||
.prose code { font-size: .86em; }
|
||||
@media (min-width: 1201px) {
|
||||
.home-layout { grid-template-columns: 240px minmax(0,1fr); }
|
||||
.reading-layout { grid-template-columns: 240px minmax(0,1fr) 222px; }
|
||||
}
|
||||
@media (min-width: 761px) and (max-width: 1200px) {
|
||||
.home-layout, .reading-layout { grid-template-columns: 224px minmax(0,1fr); }
|
||||
}
|
||||
@media (max-width: 760px) {
|
||||
.top-nav { overflow: visible; }
|
||||
.collection-picker { width: 100%; max-width: 100%; }
|
||||
.picker-category { display: none; }
|
||||
.collection-picker select { padding-block: 6px; }
|
||||
.mobile-navigation .nav-group { margin-top: 16px; }
|
||||
}
|
||||
|
||||
+111
-21
@@ -21,90 +21,180 @@
|
||||
"group": "架构设计",
|
||||
"description": "Endor 的全球入口、区域运行时与对象数据。",
|
||||
"draft": true,
|
||||
"featured": true
|
||||
"featured": true,
|
||||
"slug": "endor/endor-concepts-draft",
|
||||
"category": "Endor"
|
||||
},
|
||||
"01-getting-started": {
|
||||
"group": "开始使用",
|
||||
"description": "本地开发、文档编写与发布。"
|
||||
"description": "本地开发、文档编写与发布。",
|
||||
"slug": "endor/getting-started",
|
||||
"category": "Endor"
|
||||
},
|
||||
"02-mounting-draft": {
|
||||
"group": "架构设计",
|
||||
"description": "节点、对象与统一接入协议。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "endor/mounting-draft",
|
||||
"category": "Endor"
|
||||
},
|
||||
"03-figures": {
|
||||
"group": "图形档案",
|
||||
"description": "Python 源码与可编辑 SVG 的制图工作流。"
|
||||
"description": "Python 源码与可编辑 SVG 的制图工作流。",
|
||||
"slug": "endor/figures",
|
||||
"category": "Endor"
|
||||
},
|
||||
"04-endor-purpose-draft": {
|
||||
"group": "项目讨论",
|
||||
"description": "从程序入口走向用户与 AI 的对象操作。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "endor/endor-purpose-draft",
|
||||
"category": "Endor"
|
||||
},
|
||||
"05-object-graphs-gc": {
|
||||
"collection": "对象关系与垃圾回收",
|
||||
"group": "运行时基础",
|
||||
"description": "从对象引用环到标记清除、分代回收与跨代引用,记录内存管理讨论。"
|
||||
"description": "从对象引用环到标记清除、分代回收与跨代引用,记录内存管理讨论。",
|
||||
"slug": "language-and-runtime/object-relations/object-graphs-gc",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"pretext/00-overview": {
|
||||
"description": "理解高性能文本布局的原理,沿着 12 章教程阅读源码。",
|
||||
"featured": true
|
||||
"featured": true,
|
||||
"slug": "source-studies/pretext/overview",
|
||||
"category": "源码研究"
|
||||
},
|
||||
"language-design/00-overview": {
|
||||
"description": "从名称与作用域到反射与表示,按 271 项议题逐步讨论语言设计。",
|
||||
"featured": true
|
||||
"featured": true,
|
||||
"slug": "language-and-runtime/language-design/overview",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"language-design/02-questions": {
|
||||
"description": "语言设计讨论底稿;包含问题、验收要求和当前确认状态。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "language-and-runtime/language-design/names-and-scope",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"language-design/03-questions": {
|
||||
"description": "语言设计讨论底稿;包含问题、验收要求和当前确认状态。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "language-and-runtime/language-design/values-and-types",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"language-design/04-questions": {
|
||||
"description": "语言设计讨论底稿;包含问题、验收要求和当前确认状态。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "language-and-runtime/language-design/storage-and-lifetimes",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"language-design/05-questions": {
|
||||
"description": "语言设计讨论底稿;包含问题、验收要求和当前确认状态。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "language-and-runtime/language-design/objects-and-members",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"language-design/06-questions": {
|
||||
"description": "语言设计讨论底稿;包含问题、验收要求和当前确认状态。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "language-and-runtime/language-design/expressions-and-operators",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"language-design/07-questions": {
|
||||
"description": "语言设计讨论底稿;包含问题、验收要求和当前确认状态。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "language-and-runtime/language-design/functions-and-calls",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"language-design/08-questions": {
|
||||
"description": "语言设计讨论底稿;包含问题、验收要求和当前确认状态。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "language-and-runtime/language-design/control-flow",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"language-design/09-questions": {
|
||||
"description": "语言设计讨论底稿;包含问题、验收要求和当前确认状态。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "language-and-runtime/language-design/collections-and-access",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"language-design/10-questions": {
|
||||
"description": "语言设计讨论底稿;包含问题、验收要求和当前确认状态。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "language-and-runtime/language-design/errors-and-resources",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"language-design/11-questions": {
|
||||
"description": "语言设计讨论底稿;包含问题、验收要求和当前确认状态。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "language-and-runtime/language-design/modules-and-execution",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"language-design/12-questions": {
|
||||
"description": "语言设计讨论底稿;包含问题、验收要求和当前确认状态。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "language-and-runtime/language-design/concurrency-and-async",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"language-design/13-questions": {
|
||||
"description": "语言设计讨论底稿;包含问题、验收要求和当前确认状态。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "language-and-runtime/language-design/external-interaction",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"language-design/14-questions": {
|
||||
"description": "语言设计讨论底稿;包含问题、验收要求和当前确认状态。",
|
||||
"draft": true
|
||||
"draft": true,
|
||||
"slug": "language-and-runtime/language-design/reflection-and-representation",
|
||||
"category": "语言与运行时"
|
||||
},
|
||||
"pretext/01-chapter": {
|
||||
"slug": "source-studies/pretext/text-measurement",
|
||||
"category": "源码研究"
|
||||
},
|
||||
"pretext/02-chapter": {
|
||||
"slug": "source-studies/pretext/prepare-and-layout",
|
||||
"category": "源码研究"
|
||||
},
|
||||
"pretext/03-chapter": {
|
||||
"slug": "source-studies/pretext/text-segmentation",
|
||||
"category": "源码研究"
|
||||
},
|
||||
"pretext/04-chapter": {
|
||||
"slug": "source-studies/pretext/measurement-cache",
|
||||
"category": "源码研究"
|
||||
},
|
||||
"pretext/05-chapter": {
|
||||
"slug": "source-studies/pretext/line-breaking",
|
||||
"category": "源码研究"
|
||||
},
|
||||
"pretext/06-chapter": {
|
||||
"slug": "source-studies/pretext/height-only-layout",
|
||||
"category": "源码研究"
|
||||
},
|
||||
"pretext/07-chapter": {
|
||||
"slug": "source-studies/pretext/long-text",
|
||||
"category": "源码研究"
|
||||
},
|
||||
"pretext/08-chapter": {
|
||||
"slug": "source-studies/pretext/accuracy",
|
||||
"category": "源码研究"
|
||||
},
|
||||
"pretext/09-chapter": {
|
||||
"slug": "source-studies/pretext/virtual-lists",
|
||||
"category": "源码研究"
|
||||
},
|
||||
"pretext/10-chapter": {
|
||||
"slug": "source-studies/pretext/performance-verification",
|
||||
"category": "源码研究"
|
||||
},
|
||||
"pretext/11-chapter": {
|
||||
"slug": "source-studies/pretext/source-reading",
|
||||
"category": "源码研究"
|
||||
},
|
||||
"pretext/12-chapter": {
|
||||
"slug": "source-studies/pretext/applying-the-design",
|
||||
"category": "源码研究"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -16,7 +16,7 @@ pnpm dev
|
||||
|
||||
## 添加文档
|
||||
|
||||
在 `content/docs` 下添加 Markdown 文件,例如 `04-runtime.md`。文件名使用小写字母、数字和连字符;第一个一级标题是导航标题。该文件对应 `/docs/04-runtime`。
|
||||
在 `content/docs` 下添加 Markdown 文件,例如 `04-runtime.md`。文件名使用小写字母、数字和连字符;第一个一级标题是导航标题。在 `content/catalog.json` 的 `documents` 中以源文件路径登记 `slug` 和 `category`,例如 `slug: "endor/runtime"`、`category: "Endor"`。公开地址为 `/docs/endor/runtime`;源文件编号仅用于排序,不进入公开 URL。既有源文件地址保留永久跳转,修改已有公开 slug 时需另行保留旧地址映射。
|
||||
|
||||
开发模式下刷新页面读取修改;本地生产预览需要重新构建。
|
||||
|
||||
|
||||
@@ -16,4 +16,27 @@ pnpm figures
|
||||
|
||||
CI 会重新生成图片并检查与提交版本一致。Python 依赖保留独立缓存,不进入生产运行镜像。
|
||||
|
||||
图形应使用本地字体与资源,并明确标注草案状态。未来可按具体需求加入自动布局、PNG 转换或 TypeScript SVG 工具。
|
||||
图形应使用本地字体与资源,并明确标注草案状态。未来可按具体需求加入自动布局或 TypeScript SVG 工具。
|
||||
|
||||
## 位图默认发布压缩版本
|
||||
|
||||
SVG 保留可编辑矢量格式;漫画、照片等位图的原始 PNG、JPEG 放在 `tools/figures/assets`,不放进 `public`。浏览器只使用生成的 WebP,正文、点击放大和图片适应屏幕都使用同一个压缩地址。
|
||||
|
||||
共享策略位于 `content/image-policy.json`:默认最大宽度 1600 像素、WebP 质量 82、每张图最多 192 KiB,不放大小图。修改策略后重新生成并检查公式、细线和小字是否清晰。
|
||||
|
||||
以下涉及图像编码与构建产物生成的命令在已确认的远程 CI/CD runner 上执行;未获明确许可时不在用户本机运行。
|
||||
|
||||
```sh
|
||||
pnpm --filter @endor/docs images
|
||||
pnpm --filter @endor/docs test:images
|
||||
```
|
||||
|
||||
原图相对 `tools/figures/assets` 的路径会映射到 `apps/docs/public/figures` 下同名的 `.webp`。例如 `endor-review-gate.png` 对应 `/figures/endor-review-gate.webp`。文档只嵌入后一个地址,制作原稿不随网页发布。
|
||||
|
||||
远程生产构建会运行压缩脚本;CI 先生成 WebP,再重新编码核对产物与原稿、策略是否一致。WebP 是构建派生文件,不必在本机生成或提交;Git 保存原稿、制作记录与共享策略。检查同时拒绝公开目录里的原始位图及 Markdown 图片或 HTML img 直接引用的原始 PNG、JPEG。SVG 无需转成位图,仍按前述流程提交可编辑输出。
|
||||
|
||||
## 同一位置切换多张配图
|
||||
|
||||
把两张或更多 `/figures/endor-` 图片写在同一段,中间换行但不插入空行,正文会将它们呈现为图组。左右按钮和键盘左右方向键可以切换,下方圆点表示当前图片,也可点击直接选择。图片保留点击放大能力。
|
||||
|
||||
图组一次只挂载当前图片,切换后才加载下一张压缩图,不预先下载整组原图。
|
||||
|
||||
@@ -16,6 +16,54 @@
|
||||
|
||||
这一定位希望形成的体验是:**对象池构成持续可用的工作世界,Agent 成为其中执行工作的主体,Endor 语言让对象和行为能够被表达、检查与组合。** 用户与 AI 因而可以在同一套对象基础上发起、接续和检查工作。这是本文的设计方向,不表示所有系统能力已经实现。
|
||||
|
||||
## 让产出成为检查下一次产出的帮手
|
||||
|
||||

|
||||

|
||||
|
||||
两张漫画用检查门与检查台表达同一个目标,可用左右按钮或下方圆点切换。
|
||||
|
||||
上方把 Coding Agent 比作一台不断吐出工作结果的机器。机器可以持续产出,但人的时间和精力没有同步增长;等待检查的材料越积越多。虚线圈出的 **∫dW** 表示累积的待处理工作,门上的 **C₀** 表示在这个对比中保持不变的检查能力。通过门、带上勾的文件才表示已处理的结果。
|
||||
|
||||
下方的机器吐出同样的原始文件,改变的是 Endor 如何组织和接续这些产出。人和检查门直接面对的是这次新增的 **dW**;已经处理的文件被组织成有类型、来源、关系与可调用能力的对象,成为图里的蓝色帮手。帮手的箭头指向检查门,表达它们为后续检查提供支持,而不是让新生成的结果自己证明自己正确。
|
||||
|
||||
例如,已确认的需求可以成为验收条件;稳定的接口约定可以帮助发现不兼容修改;图片发布规则可以检查下一份文档有没有直接嵌入原图。**过去的产出从待处理的负担,逐步变成帮助人处理新工作的能力。** 新结果是否符合要求,仍需要适用的检查逻辑与人的判断。
|
||||
|
||||
门上的 **C₀ + k∫dW** 表示我们希望实现的积累效应:在原有能力上,增加由历史成果转化而来的可复用检查能力。这里的积分、微分和系数 k 是设计隐喻,不是性能公式或实测结论;只有经过确认、适合复用并保持有效的成果才能贡献能力,产出数量不等于正确性,实际检查也可能需要重新覆盖受影响的历史对象。
|
||||
|
||||
> **设计目标**:这张漫画表达希望建立的工作组织方式,不表示当前 Endor 已能自动把任意文件变成检查工具。要兑现它,需要保存来源和依赖、表达检查规则、执行检查,并把失败与待确认事项呈现给人。
|
||||
|
||||
## 从压缩图片想到的继承:让要求成为共同能力
|
||||
|
||||
这张漫画也带来一个具体要求:**文档在浏览器中默认使用压缩图,原图留作制作与归档,不因打开正文或放大图片就下载原图。** 如果很多文档都需要这条规则,用户不应该每次写文档时重新提醒一次。
|
||||
|
||||
单次 Coding Agent 对话中的“记得压缩图片”,通常首先是一项需要读取、理解和落实的指令。指令可以放进项目约定、技能或模板,也可以让 Agent 写出共享压缩脚本;这些都能减少重复劳动。但一句自然语言要求本身,并没有自动建立“这类文档如何派生、谁沿用默认行为、哪个文档允许覆盖”的类型与行为关系。这里讨论的是这种**可持续、可检查的继承**,不是说 Agent 不能编写使用继承的程序。
|
||||
|
||||
### 为什么 Endor 的设计能承载继承
|
||||
|
||||
在现有设计中,文档、图片、类型定义、函数和 Agent 都进入同一对象体系。对象具有可引用的身份,类型可以表达对象的结构与能力,函数可以表达处理行为;继承、实例化与代码依赖可以保存为有不同含义的关联。因此,“默认如何发布文档图片”可以被表达为一个可引用的共同定义,以及读取和执行它的行为,而不只是一段随对话流逝的提醒。
|
||||
|
||||
沿着这个设计方向,可以把图片发布要求放到共享文档类型或其呈现策略上:普通文档沿用“优先压缩图”的默认行为,需要精确查看像素的专业文档再显式采用另一种策略。具体通过类型继承、策略对象委托还是能力组合实现,需要结合语言规则确定;不是因为对象之间有一个链接,就天然获得了继承。
|
||||
|
||||
| 层次 | 压缩图例子中承担的职责 |
|
||||
| --- | --- |
|
||||
| 共同定义 | 保存默认图片尺寸、编码质量、字节预算及浏览器应使用的派生版本 |
|
||||
| 继承或委托关系 | 让采用共同定义的文档持续引用它,明确哪些行为来自共同来源 |
|
||||
| 实际处理能力 | 根据策略生成压缩版本,保留它与原图的来源关系,并让呈现入口选择压缩版本 |
|
||||
| 检查与覆盖 | 检查新产出是否符合默认要求;特例显式选择覆盖,并能说明生效的规则来自哪里 |
|
||||
|
||||
关键不只是“记住用户偏好”,而是**规则有归属,使用者有关系,行为可以执行,结果能够检查**。当 Agent 新建同类文档时,它使用已有文档能力与策略,就能让之前确认的要求继续参与这次工作;人主要判断本次差异和真正的例外。这也是漫画里历史成果增强检查门的一个具体例子。
|
||||
|
||||
定义和依赖是对象,使系统有基础追踪受影响的文档,并通过名称、类型与调用检查发现部分不一致;图片编码与发布仍需实际运行相应能力。“一切皆对象”本身不保证每份文档都调用正确的渲染器,也不自动决定规则修改后是否追溯更新历史文档。
|
||||
|
||||
> **语义边界**:继承与委托、覆盖与冲突规则仍在[语言设计问题集的对象模型部分](/docs/language-design/05-questions)讨论中。父定义更新如何生效、文档是否绑定特定版本、多来源冲突如何处理,需要明确后才能成为稳定承诺。这里解释 Endor 为什么有承载这类继承的共同基础,以及希望形成的体验,不宣称这些规则已全部实现。
|
||||
|
||||
### 本站现在怎样落实这条规则
|
||||
|
||||
Tabularium 目前用共享构建策略落实这项要求:原图保存在非公开的制作目录,脚本统一生成有尺寸、质量与字节预算的 WebP,文档正文和放大查看都使用这个压缩版本。新增文档直接引用生成的图片,不需要逐篇重新实现压缩;构建检查会拒绝公开原始位图或直接嵌入原始 PNG、JPEG。
|
||||
|
||||
这是今天在文档仓库里可以执行和验证的共享规则,具体工作流见[图形与脚本](/docs/03-figures)。它示范了“把一次提醒变成后续工作可复用的能力”,并不表示 Tabularium 这个 Next.js 网站已经运行了 Endor 的继承机制。
|
||||
|
||||
## 一对图:我们希望改变什么
|
||||
|
||||

|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"maxWidth": 1600,
|
||||
"quality": 82,
|
||||
"maxBytes": 196608
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
# 文档 UI 验收 · 2026-10-28
|
||||
|
||||
参考 Supabase Database Overview 与 AI Tools 的桌面界面:共用排版,分别维护文档标识、局部目录与顶部上下文。保留 Tabularium 品牌与现有文档路径。
|
||||
|
||||
## 实现
|
||||
|
||||
- 顶部切换文档,显示当前选中项。左侧显示当前文档名称、图标、独立目录和返回入口;面包屑连接该文档入口。
|
||||
- 文档中心按合集提供入口,不把所有章节铺成卡片。原有筛选、分页和全文搜索保留;阅读页搜索提示显示当前文档范围。
|
||||
- 移除导航、卡片、提示、代码、表格和上下篇等区域的多数边框,以留白、浅色表面和轻渐变建立层次。不同文档使用克制的强调色。
|
||||
- 入口提供 hover 浮起和箭头反馈;选中项、链接和搜索有过渡;正文及对话框有短暂进入效果。系统设置减少动态效果时关闭动画和过渡。
|
||||
|
||||
## 验证
|
||||
|
||||
- ESLint、类型检查、Next.js webpack 生产构建通过。认证单元测试 3/3 通过。
|
||||
- 对最终生产构建运行原有 auth-cli verify:全部文档、搜索索引、附件、静态资源、404 和认证边界通过。
|
||||
- 浏览器开发预览:1440×900 桌面检查首页、Pretext、语言设计;顶部点击切换后局部目录和搜索提示更新。搜索 nonlocal 返回本合集两篇文章,方向键与 Enter 能打开章节。
|
||||
- 390×844 检查正文、顶部横向文档切换和本地目录展开;截图未见正文横向溢出。
|
||||
- 下图为开发预览截图,左下角 Next.js 开发按钮不进入生产产物。生产产物已完成 HTTP 验收;额外的生产浏览器截图因原开发标签页关闭后连接失效未保存。
|
||||
- 不代表远程 CI 已完成,也不代表 PR 已合并或生产环境已部署。
|
||||
|
||||

|
||||
Binary file not shown.
|
After Width: | Height: | Size: 67 KiB |
+1
-1
@@ -13,7 +13,7 @@
|
||||
"lint": "pnpm --filter @endor/docs run lint",
|
||||
"typecheck": "pnpm --filter @endor/docs run typecheck",
|
||||
"figures": "uv run --locked --project tools/figures endor-figures",
|
||||
"check": "pnpm run lint && pnpm run typecheck && pnpm run test:auth && pnpm run figures && pnpm run build",
|
||||
"check": "pnpm run lint && pnpm run typecheck && pnpm run test:auth && pnpm --filter @endor/docs run images && pnpm --filter @endor/docs run test:images && pnpm run figures && pnpm run build",
|
||||
"test:auth": "pnpm --filter @endor/docs run test:auth"
|
||||
}
|
||||
}
|
||||
|
||||
Generated
+4
-3
@@ -59,6 +59,9 @@ importers:
|
||||
postcss:
|
||||
specifier: 8.5.31
|
||||
version: 8.5.31
|
||||
sharp:
|
||||
specifier: 0.35.5
|
||||
version: 0.35.5(@types/node@22.20.5)
|
||||
tailwindcss:
|
||||
specifier: 4.3.3
|
||||
version: 4.3.3
|
||||
@@ -2876,8 +2879,7 @@ snapshots:
|
||||
|
||||
'@humanwhocodes/retry@0.4.3': {}
|
||||
|
||||
'@img/colour@1.1.0':
|
||||
optional: true
|
||||
'@img/colour@1.1.0': {}
|
||||
|
||||
'@img/sharp-darwin-arm64@0.35.5':
|
||||
optionalDependencies:
|
||||
@@ -5184,7 +5186,6 @@ snapshots:
|
||||
'@img/sharp-win32-ia32': 0.35.5
|
||||
'@img/sharp-win32-x64': 0.35.5
|
||||
'@types/node': 22.20.5
|
||||
optional: true
|
||||
|
||||
shebang-command@2.0.0:
|
||||
dependencies:
|
||||
|
||||
@@ -6,6 +6,8 @@ uv sync --project tools/figures --locked
|
||||
pnpm run lint
|
||||
pnpm run typecheck
|
||||
pnpm --filter @endor/docs run test:auth
|
||||
pnpm --filter @endor/docs run images
|
||||
pnpm --filter @endor/docs run test:images
|
||||
cp -R apps/docs/public/figures /tmp/expected-figures
|
||||
pnpm run figures
|
||||
uv run --locked --project tools/figures python -m unittest discover -s tools/figures/tests -v
|
||||
|
||||
+1
-1
@@ -27,7 +27,7 @@ def verify(base: str) -> None:
|
||||
assert status == 200 and json.loads(health) == {"status": "ok"}
|
||||
status, _, login = get("/login")
|
||||
assert status == 200 and "输入动态码" in login.decode()
|
||||
for path in ("/", "/docs/00-endor-concepts-draft", "/figures/endor-architecture.svg", "/docs/pretext/01-chapter", "/materials/pretext/verify.cjs", "/materials/pretext/results.chrome156.json"):
|
||||
for path in ("/", "/docs/00-endor-concepts-draft", "/figures/endor-architecture.svg", "/figures/endor-review-gate.webp", "/figures/endor-review-desk.webp", "/docs/pretext/01-chapter", "/materials/pretext/verify.cjs", "/materials/pretext/results.chrome156.json"):
|
||||
status, headers, _ = get(path)
|
||||
assert status == 307, path
|
||||
target = urllib.parse.urlparse(urllib.parse.urljoin(base, headers["Location"]))
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 1.7 MiB |
@@ -0,0 +1,14 @@
|
||||
Endor inspection desk comic — approved second slide
|
||||
|
||||
Source: built-in image_gen; physics inspection-bench variant with corrected top-row flow.
|
||||
Original: exec-432e0f3d-d01d-4658-b5d5-0c63db95e472.png
|
||||
The user selected this alongside the gate variant for one carousel.
|
||||
|
||||
The two identical machines emit raw papers. Above, a dashed integral dW boundary
|
||||
encloses the backlog BEFORE one person's fixed-capacity C0 inspection desk.
|
||||
Below, a dashed dW boundary encloses the one new paper being inspected. Earlier
|
||||
checked outputs become structured document helpers that contribute additional
|
||||
magnifiers to the Endor desk, whose capacity is C0 + k integral dW.
|
||||
|
||||
Store this PNG as the production master outside public. The confirmed remote
|
||||
runner generates /figures/endor-review-desk.webp using content/image-policy.json.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 1.4 MiB |
@@ -0,0 +1,20 @@
|
||||
Endor review gate comic — approved source
|
||||
|
||||
Source: built-in image_gen, physics gate variant, approved by the user on 2026-10-28.
|
||||
Original: exec-380f8db3-6450-4981-97df-473c13a62223.png
|
||||
The PNG is the production master, not a public browser asset.
|
||||
The confirmed remote runner generates the browser WebP with:
|
||||
pnpm --filter @endor/docs images
|
||||
|
||||
Visual specification:
|
||||
Two rows, white background, charcoal outlines, blue accents, identical coding
|
||||
machines emitting identical raw sheets. Top: accumulated unchecked sheets inside
|
||||
a dashed integral dW boundary, one person and a fixed C0 inspection gate, checked
|
||||
output after the gate. Bottom: one new sheet inside a dashed dW boundary directly
|
||||
inspected by a stick figure at an Endor gate. Gate capacity is C0 + k integral dW.
|
||||
Checked output becomes a structured document helper, joins historical helpers,
|
||||
and blue arrows from helpers feed the gate to increase inspection capability.
|
||||
No dialogue or explanatory prose. Math is a conceptual metaphor, not measured data.
|
||||
|
||||
The bitmap master retains the approved artwork, including its mathematical
|
||||
symbols. Browser optimization changes encoding and dimensions only.
|
||||
Reference in New Issue
Block a user