@unana_dev/doxen 0.0.0-stage → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Safience Una
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,136 @@
1
- # Temporary Holding Version
1
+ # Safibook
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ > 기존 저장소의 Markdown 폴더를 설정 파일 하나로 연결하는 npm 패키지입니다. Node.js 20.19 이상이 필요합니다. 현재 0.1.1 구현 기준입니다.
4
+
5
+ 상단 탭, 폴더별 문서 탐색, 목차, 한국어 전체 검색, 검색 위치 이동, 문서 및 지정 섹션 안에서 찾기 기능을 제공합니다. React/Vue 등 사용자 프로젝트의 프레임워크에 의존하지 않으며, 사이트 소스는 패키지 안에 있습니다.
6
+
7
+ ## 설치와 시작
8
+
9
+ npm 레지스트리에 배포된 패키지는 다음과 같이 설치합니다. 로컬 설치는 `npm pack`으로 만든 tgz 경로를 패키지명 대신 사용합니다.
10
+
11
+ ```bash
12
+ npm install -D @unana_dev/doxen
13
+ npx docs init
14
+ npm run docs:dev
15
+ npm run docs:build
16
+ ```
17
+
18
+ Yarn도 같은 패키지를 사용할 수 있습니다.
19
+
20
+ ```bash
21
+ yarn add -D @unana_dev/doxen
22
+ yarn safibook init
23
+ yarn docs:dev
24
+ yarn docs:build
25
+ ```
26
+
27
+ `docs`라는 실행 파일이 다른 의존성과 겹치면 동일한 CLI인 `safibook`을 사용하세요. 생성되는 스크립트는 충돌을 줄이기 위해 `safibook`을 사용합니다.
28
+
29
+ `init`은 기존 설정, 문서, 프로젝트 스크립트를 덮어쓰지 않습니다. 설정이 없으면 `docs/README.md`, `docs.config.ts`를 만들고 `docs:dev`, `docs:build` 스크립트를 추가합니다. `.gitignore`에는 생성물과 `node_modules`를 등록합니다. 이미 문서 폴더가 있다면 설정 파일의 경로만 연결하고 생성된 시작 문서는 필요에 따라 제거하세요.
30
+
31
+ ## 설정
32
+
33
+ ```ts
34
+ // docs.config.ts
35
+ export default {
36
+ title: '팀 문서',
37
+ tabs: [
38
+ { title: '정책서', dir: './pharma', slug: 'pharma' },
39
+ { title: '프론트엔드', dir: './fe', slug: 'fe' },
40
+ { title: '백엔드', dir: './be', slug: 'be' },
41
+ ],
42
+ };
43
+ ```
44
+
45
+ 선택적으로 `import { defineConfig } from '@unana_dev/doxen'`을 사용하면 타입 도움을 받을 수 있습니다. `.ts`, `.mjs`, `.js` 설정을 지원합니다. 설정 파일은 Node에서 실행되므로 신뢰할 수 있는 저장소에서 사용하세요.
46
+
47
+ - `dir`: 설정 파일 기준의 전용 하위 폴더. 저장소 루트 또는 외부 폴더는 허용하지 않습니다.
48
+ - `slug`: 고유한 영문 소문자·숫자·하이픈. 문서 URL의 일부입니다.
49
+ - 파일 이름순(숫자 순서 인식)으로 정렬합니다. `01-introduction.md`처럼 번호를 붙이면 순서를 제어할 수 있습니다.
50
+ - 하위 폴더는 탐색 목록에 경로로 표시합니다. 숨김 파일, `node_modules`, 심볼릭 링크 문서는 제외합니다.
51
+ - 탭 전체 내용은 같은 정적 사이트에 포함됩니다. 탭별 권한 분리는 제공하지 않습니다.
52
+
53
+ ## 명령
54
+
55
+ | 명령 | 기능 |
56
+ | --- | --- |
57
+ | `docs init` | 시작 문서, 설정, 스크립트, Git 제외 설정 |
58
+ | `docs dev` | `http://127.0.0.1:4173` 미리보기와 변경 시 자동 새로고침 |
59
+ | `docs dev --port 4200` | 포트 변경 |
60
+ | `docs build` | 설정 파일 옆 `.docs-dist/`에 정적 사이트 생성 |
61
+ | `docs build --config ./config/docs.config.ts` | 설정 파일 지정 (dev, ai에도 적용) |
62
+ | `docs ai --file docs/guide.md --instruction "변경 요청"` | 표준 문서 양식과 AI 편집 작업 지침을 stdout에 출력 |
63
+
64
+ 빌드는 자체 생성 표시가 있는 출력 폴더만 교체합니다. 문서 변환에 실패하면 이전 성공 결과를 유지합니다. 출력에는 문서 HTML과 검색용 본문이 포함되므로 소스가 비공개라면 결과물도 비공개로 배포해야 합니다.
65
+
66
+ ## 검색과 문서 작성
67
+
68
+ `⌘/Ctrl K` 또는 상단 검색 버튼으로 모든 탭의 제목·본문·표·코드를 검색합니다. 공백으로 나눈 단어를 모두 포함하는 섹션을 찾으며 제목에 일치하는 결과를 먼저 표시합니다. 한국어 Unicode 정규화와 영문 대소문자 구분 없는 부분 일치를 지원합니다. 형태소 분석·오타 교정 검색은 포함하지 않습니다.
69
+
70
+ 결과를 선택하면 해당 문서와 제목 위치로 이동하며 일치하는 글자를 표시합니다. 문서 상단 검색창 또는 다음과 같은 섹션 검색창에서 이전·다음 버튼, Enter / Shift+Enter로 이동합니다. 검색은 현재 선택한 한 영역에 적용됩니다. 섹션 및 문서 내 검색은 입력한 문자열이 포함된 표의 본문 행만 남기고 나머지 행을 숨깁니다. 표 머리글은 유지하며 검색어를 지우면 모든 행을 복원합니다. 영문 대소문자와 한국어 Unicode 정규화를 적용하고 앞뒤 공백을 제외한 연속 문자열로 비교합니다. 표 밖의 본문은 숨기지 않고 일치 위치를 강조합니다.
71
+
72
+ ```markdown
73
+ ## 1. 환불 정책
74
+
75
+ :::search 정책 검색
76
+
77
+ | 조건 | 처리 |
78
+ | --- | --- |
79
+ | 결제 취소 | 정산 내역 확인 후 환불 |
80
+ :::
81
+ ```
82
+
83
+ 번호가 있는 제목은 검색 영역 밖에 두세요. 제목 바로 아래에 `:::search 영역 이름`을 작성하면 해당 영역에만 검색창이 표시됩니다. 검색이 필요 없는 섹션은 일반 Markdown으로 작성합니다. 기존처럼 검색 영역 안에 첫 제목을 작성한 문서도 화면에서는 제목 아래로 검색창을 배치합니다. 전체 검색은 헤더 중앙, 문서 전체에서 찾기는 본문 상단의 접이식 메뉴로 제공합니다.
84
+
85
+ 표준 Markdown, 코드 블록, 표, 상대 `.md` 링크, 한국어 제목 앵커, 이미지와 PDF 첨부를 지원합니다. 연결된 PNG/JPEG/GIF/WebP/AVIF/ICO/PDF만 복사하며 문서 폴더 밖 첨부는 빌드 오류로 처리합니다. 로컬 파일 링크는 현재 문서 기준 상대 경로를 사용하세요. 한 문서의 여러 검색 영역을 나란히 구성할 수 있으며 중첩 검색 영역은 사용하지 마세요.
86
+
87
+ 제목은 자동으로 목차에 표시됩니다. 중복 제목에는 `-1`, `-2`가 붙습니다. Markdown 링크가 존재하지 않는 문서 파일을 가리키면 빌드를 중단합니다. 대상 제목 앵커의 존재 여부는 별도로 검사하지 않습니다.
88
+
89
+ 실행 가능한 HTML, MDX, YAML frontmatter 메타데이터, 확장 Markdown 플러그인은 현재 지원하지 않습니다. 원시 HTML은 실행하지 않고 텍스트로 표시하며 결과 HTML을 정제합니다. 외부 이미지·링크는 원래 URL을 유지합니다.
90
+
91
+ ## AI로 정해진 양식에 맞추기
92
+
93
+ ```bash
94
+ npx docs ai --file pharma/refund.md --instruction "현재 근거를 유지하고 환불 정책을 표로 정리" > /tmp/refund-prompt.txt
95
+ ```
96
+
97
+ 생성된 내용을 사용 중인 AI 코딩 도구에 전달하세요. 문서 정보 범위 → 번호별 단계 → 예외 → 관련 문서 순서의 양식과 기존 문서, 요청을 함께 제공합니다. 결과를 검토하여 Markdown에 반영한 다음 미리보기와 Git diff를 확인합니다.
98
+
99
+ 이 명령은 API를 호출하거나 파일을 자동 수정하지 않습니다. AI 제공자·모델·인증 설정이 정해지지 않아 현재 버전은 도구에 전달할 작업 지침 생성까지 제공합니다. 출력에 기존 문서 전문이 포함되므로 공유 범위는 원본 문서와 동일하게 취급하세요.
100
+
101
+ ## Cloudflare Pages 배포와 계정 제한
102
+
103
+ 호스팅 계정 연결 및 Access 정책은 각 문서 프로젝트에서 설정합니다. 현재 저장소에는 실제 Cloudflare 프로젝트나 계정 정책이 연결되어 있지 않습니다.
104
+
105
+ 1. GitHub에 문서, 설정, package.json과 lockfile을 올립니다. 패키지 tgz를 로컬 절대 경로로 설치한 상태라면 npm에 게시된 버전으로 교체하거나, tgz를 저장소에 넣고 `file:./vendor/…tgz` 상대 경로로 설치하세요.
106
+ 2. Pages에 해당 Git 저장소를 연결합니다. 프레임워크는 None, 빌드 명령은 `npm run docs:build`, 출력 디렉터리는 `.docs-dist`, 프로덕션 브랜치는 `main`으로 설정합니다. Node 버전은 22 이상으로 지정합니다. Yarn 프로젝트는 해당 lockfile과 `yarn docs:build`를 사용합니다.
107
+ 3. 커스텀 도메인을 쓸 경우 먼저 Pages에 연결한 후 Access를 설정합니다.
108
+ 4. Pages의 **Enable access policy**를 활성화합니다. 이 기본 설정만으로 운영 주소가 보호되는 것은 아닙니다.
109
+ 5. 만들어진 Access 애플리케이션의 호스트에서 와일드카드를 제거해 `<project>.pages.dev`를 보호합니다. Pages에서 access policy를 다시 활성화해 `*.<project>.pages.dev` 미리보기 정책도 별도로 만듭니다.
110
+ 6. 커스텀 도메인은 Zero Trust에서 별도의 Self-hosted 애플리케이션으로 등록합니다. 각 호스트 전체에 허용 이메일·그룹 기반 Allow 정책을 적용하며 Bypass/Everyone 정책은 두지 않습니다.
111
+ 7. 로그아웃 또는 시크릿 창에서 운영·미리보기·커스텀 도메인의 `/`, `/site.json`, `/assets/...`를 각각 확인합니다. 미허용 계정이 내용을 읽을 수 없어야 합니다. 민감 문서는 이 확인을 마친 뒤 배포합니다.
112
+
113
+ `main`에 병합하면 Pages의 Git 연동으로 다시 빌드합니다. 롤백은 Pages의 이전 정상 배포를 선택하거나 Git 변경을 되돌립니다. 브라우저 코드에는 인증 비밀키를 넣지 않습니다.
114
+
115
+ 공식 근거: [정적 HTML 배포](https://developers.cloudflare.com/pages/framework-guides/deploy-anything/), [미리보기 배포](https://developers.cloudflare.com/pages/configuration/preview-deployments/), [pages.dev·커스텀 도메인 Access 설정](https://developers.cloudflare.com/pages/platform/known-issues/#enable-access-on-your-pagesdev-domain).
116
+
117
+ ## 패키지 개발·검증·게시
118
+
119
+ ```bash
120
+ npm ci
121
+ npm run dev # 예제 사이트
122
+ npm run check # Node 테스트와 문법 검사
123
+ npm run test:browser # Chromium 브라우저 테스트
124
+ npm run test:package # tgz를 별도 프로젝트에 설치하여 검증
125
+ npm run build # 예제 정적 빌드
126
+ npm pack --dry-run # 배포 파일 목록 검토
127
+ npm pack
128
+ ```
129
+
130
+ 브라우저 테스트는 먼저 `npx playwright install chromium`을 실행하세요. 기존 Chrome을 쓰려면 `PLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH`에 실행 파일 경로를 설정할 수 있습니다. npm에 게시하려면 스코프 소유권·이름 사용 가능 여부·로그인을 확인한 뒤 버전을 갱신하고 `npm publish --access public`을 실행합니다. 게시 여부는 이 저장소 구현 완료와 별개입니다.
131
+
132
+ 배포 파일은 package.json의 `files` 허용 목록으로 제한됩니다. `bin/`, `src/`, `client/`, README, LICENSE만 포함하고 예제, 테스트, 문서 저장소 원본은 포함하지 않습니다. 런타임 의존성은 일반 npm 의존성으로 설치합니다.
133
+
134
+ 구조: `bin/docs.js` → 설정 로더 → Markdown/섹션/첨부 처리 → 정적 빌드 또는 로컬 서버. 화면과 브라우저 검색은 `client/`에 있습니다. 사이트는 해시 URL을 사용해 하위 경로에서도 서버 rewrite 없이 동작합니다. 전체 문서 데이터를 한 번 내려받으므로 초기 버전은 소규모·중규모 팀 문서에 맞췄으며 대형 저장소 성능은 별도 측정이 필요합니다.
135
+
136
+ 파일 감시 한도 오류(EMFILE/ENOSPC)나 네트워크 파일시스템에서 갱신이 안 되면 `CHOKIDAR_USEPOLLING=1 npm run docs:dev`를 사용하세요. 설정·문서 오류는 터미널과 미리보기 응답에 표시되며 수정 후 새로고침하면 복구됩니다.
package/bin/docs.js ADDED
@@ -0,0 +1,60 @@
1
+ #!/usr/bin/env node
2
+ import { parseArgs } from "node:util";
3
+ import { loadConfig } from "../src/config.js";
4
+ import { init } from "../src/init.js";
5
+ import { build } from "../src/build.js";
6
+ import { dev } from "../src/dev.js";
7
+ import { prepareAi } from "../src/ai.js";
8
+
9
+ try {
10
+ const { values, positionals } = parseArgs({
11
+ allowPositionals: true,
12
+ options: {
13
+ config: { type: "string" },
14
+ port: { type: "string", default: "4173" },
15
+ file: { type: "string" },
16
+ instruction: { type: "string" },
17
+ help: { type: "boolean", short: "h" },
18
+ version: { type: "boolean", short: "v" },
19
+ },
20
+ });
21
+ const [command, ...extra] = positionals;
22
+ if (values.version) console.log("0.1.1");
23
+ else if (values.help || !command)
24
+ console.log(
25
+ `Safibook — 저장소 기반 문서 사이트\n\n docs init 설정과 스크립트 생성\n docs dev [--port 4173] 로컬 미리보기 및 자동 갱신\n docs build .docs-dist 정적 사이트 생성\n docs ai --file <문서.md> --instruction "변경 요청"\n 표준 양식과 AI 작업 지침을 stdout으로 출력\n\n옵션: --config <파일> (dev/build/ai), --help, --version\n동일 명령: safibook <명령>`,
26
+ );
27
+ else {
28
+ if (extra.length) throw new Error(`알 수 없는 인자: ${extra.join(" ")}`);
29
+ if (command === "init") {
30
+ if (values.config)
31
+ throw new Error("init은 --config 옵션을 지원하지 않습니다.");
32
+ await init(process.cwd());
33
+ } else if (command === "build")
34
+ console.log(
35
+ `빌드 완료: ${await build(await loadConfig(process.cwd(), values.config))}`,
36
+ );
37
+ else if (command === "ai")
38
+ console.log(
39
+ await prepareAi(
40
+ await loadConfig(process.cwd(), values.config),
41
+ values.file,
42
+ values.instruction,
43
+ ),
44
+ );
45
+ else if (command === "dev") {
46
+ const port = Number(values.port);
47
+ if (!Number.isInteger(port) || port < 1 || port > 65535)
48
+ throw new Error("port는 1~65535 정수여야 합니다.");
49
+ const running = await dev(process.cwd(), values.config, port);
50
+ for (const signal of ["SIGINT", "SIGTERM"])
51
+ process.once(signal, async () => {
52
+ await running.close();
53
+ process.exit(0);
54
+ });
55
+ } else throw new Error(`알 수 없는 명령: ${command}`);
56
+ }
57
+ } catch (error) {
58
+ console.error(`Safibook: ${error.message}`);
59
+ process.exitCode = 1;
60
+ }
package/client/app.js ADDED
@@ -0,0 +1,349 @@
1
+ import { searchDocuments, matchRanges, matchesRow } from "./search.js";
2
+
3
+ const $ = (selector) => document.querySelector(selector);
4
+ const el = (tag, text, className) => {
5
+ const node = document.createElement(tag);
6
+ if (text !== undefined) node.textContent = text;
7
+ if (className) node.className = className;
8
+ return node;
9
+ };
10
+ const route = (id, anchor = "") =>
11
+ `#/${encodeURIComponent(id)}${anchor ? `/${encodeURIComponent(anchor)}` : ""}`;
12
+ let site;
13
+ let current;
14
+ let activeTab;
15
+ let pendingQuery = "";
16
+ const dialog = $("#search-dialog");
17
+
18
+ function clearMarks(root) {
19
+ for (const mark of root.querySelectorAll("mark[data-hit]"))
20
+ mark.replaceWith(document.createTextNode(mark.textContent));
21
+ root.normalize();
22
+ }
23
+
24
+ function highlight(root, query) {
25
+ clearMarks(root);
26
+ const walker = document.createTreeWalker(root, NodeFilter.SHOW_TEXT, {
27
+ acceptNode(node) {
28
+ return node.parentElement.closest(".section-tools, script, style, [hidden]")
29
+ ? NodeFilter.FILTER_REJECT
30
+ : NodeFilter.FILTER_ACCEPT;
31
+ },
32
+ });
33
+ const nodes = [];
34
+ while (walker.nextNode()) nodes.push(walker.currentNode);
35
+ const hits = [];
36
+ for (const node of nodes) {
37
+ const ranges = matchRanges(node.textContent, query);
38
+ if (!ranges.length) continue;
39
+ const fragment = document.createDocumentFragment();
40
+ let offset = 0;
41
+ for (const [start, end] of ranges) {
42
+ fragment.append(
43
+ document.createTextNode(node.textContent.slice(offset, start)),
44
+ );
45
+ const mark = el("mark", node.textContent.slice(start, end));
46
+ mark.dataset.hit = "";
47
+ fragment.append(mark);
48
+ hits.push(mark);
49
+ offset = end;
50
+ }
51
+ fragment.append(document.createTextNode(node.textContent.slice(offset)));
52
+ node.replaceWith(fragment);
53
+ }
54
+ return hits;
55
+ }
56
+
57
+ let finders = [];
58
+ function attachFinder(input, root, count, prev, next) {
59
+ const rows = [...root.querySelectorAll("tbody tr")];
60
+ let hits = [];
61
+ let index = -1;
62
+ const state = {
63
+ input,
64
+ reset() {
65
+ for (const row of rows) row.hidden = false;
66
+ hits = [];
67
+ index = -1;
68
+ count.textContent = "";
69
+ prev.disabled = next.disabled = true;
70
+ },
71
+ };
72
+ finders.push(state);
73
+ const update = () => {
74
+ count.textContent = input.value
75
+ ? `${index < 0 ? 0 : index + 1} / ${hits.length}`
76
+ : "";
77
+ prev.disabled = next.disabled = !hits.length;
78
+ };
79
+ const move = (direction) => {
80
+ if (!hits.length) return;
81
+ hits[index]?.classList.remove("active-hit");
82
+ index = (index + direction + hits.length) % hits.length;
83
+ hits[index].classList.add("active-hit");
84
+ hits[index].scrollIntoView({ block: "center", behavior: "smooth" });
85
+ update();
86
+ };
87
+ input.oninput = () => {
88
+ for (const finder of finders)
89
+ if (finder !== state) {
90
+ finder.input.value = "";
91
+ finder.reset();
92
+ }
93
+ clearMarks($("#article"));
94
+ for (const row of rows) {
95
+ row.hidden = !matchesRow([...row.cells].map((cell) => cell.textContent).join(" "), input.value);
96
+ }
97
+ hits = highlight(root, input.value);
98
+ index = -1;
99
+ if (hits.length) move(1);
100
+ else update();
101
+ };
102
+ input.onkeydown = (event) => {
103
+ if (event.key === "Enter") {
104
+ event.preventDefault();
105
+ move(event.shiftKey ? -1 : 1);
106
+ }
107
+ };
108
+ prev.onclick = () => move(-1);
109
+ next.onclick = () => move(1);
110
+ state.reset();
111
+ }
112
+
113
+ function renderNavigation() {
114
+ $("#tabs").replaceChildren();
115
+ for (const tab of site.tabs) {
116
+ const first = site.documents.find((doc) => doc.tab === tab.slug);
117
+ const link = el("a", tab.title, tab.slug === activeTab ? "active" : "");
118
+ link.href = first ? route(first.id) : route(`${tab.slug}/`);
119
+ if (tab.slug === activeTab) link.setAttribute("aria-current", "page");
120
+ $("#tabs").append(link);
121
+ }
122
+ $("#documents").replaceChildren();
123
+ const folders = new Map();
124
+ for (const doc of site.documents.filter((item) => item.tab === activeTab)) {
125
+ let parent = $("#documents");
126
+ let key = "";
127
+ for (const part of doc.path.split("/").slice(0, -1)) {
128
+ key += `${part}/`;
129
+ if (!folders.has(key)) {
130
+ const group = el("details", undefined, "folder-group");
131
+ group.open = current?.path.startsWith(key) || false;
132
+ group.append(el("summary", part));
133
+ const children = el("div", undefined, "folder-children");
134
+ group.append(children);
135
+ parent.append(group);
136
+ folders.set(key, children);
137
+ }
138
+ parent = folders.get(key);
139
+ }
140
+ const link = el("a", doc.title, doc.id === current?.id ? "selected" : "");
141
+ link.href = route(doc.id);
142
+ if (doc.id === current?.id) link.setAttribute("aria-current", "page");
143
+ parent.append(link);
144
+ }
145
+ }
146
+
147
+ function render() {
148
+ let id, anchor;
149
+ try {
150
+ [id, anchor] = location.hash.slice(2).split("/").map(decodeURIComponent);
151
+ } catch {
152
+ id = "invalid";
153
+ }
154
+ current = id
155
+ ? site.documents.find((doc) => doc.id === id)
156
+ : site.documents[0];
157
+ activeTab =
158
+ current?.tab ||
159
+ site.tabs.find((tab) => id?.startsWith(`${tab.slug}/`))?.slug ||
160
+ site.tabs[0].slug;
161
+ renderNavigation();
162
+ $("#toc").replaceChildren();
163
+ $("#pagination").replaceChildren();
164
+ $("#page-search").value = "";
165
+ finders = [];
166
+ $(".document-find").open = false;
167
+ if (!current) {
168
+ $("#article").replaceChildren(
169
+ el(
170
+ "h1",
171
+ id?.endsWith("/") || !id
172
+ ? "아직 문서가 없습니다"
173
+ : "문서를 찾을 수 없습니다",
174
+ ),
175
+ el(
176
+ "p",
177
+ "설정된 폴더에 Markdown 파일을 추가하거나 왼쪽 목록에서 문서를 선택하세요.",
178
+ ),
179
+ );
180
+ $(".document-tools").hidden = true;
181
+ $("#breadcrumb").textContent = site.tabs.find(
182
+ (tab) => tab.slug === activeTab,
183
+ ).title;
184
+ return;
185
+ }
186
+ $(".document-tools").hidden = false;
187
+ document.title = `${current.title} · ${site.title}`;
188
+ $("#breadcrumb").textContent =
189
+ `${site.tabs.find((tab) => tab.slug === current.tab).title} / ${current.path}`;
190
+ $("#article").innerHTML = current.html;
191
+ if (!$("#article h1")) $("#article").prepend(el("h1", current.title));
192
+ // Existing containers with a leading heading also display the search below it.
193
+ for (const section of document.querySelectorAll(".search-section")) {
194
+ const heading =
195
+ section.querySelector(".section-content")?.firstElementChild;
196
+ if (heading && /^H[2-6]$/.test(heading.tagName)) section.before(heading);
197
+ }
198
+ for (const heading of current.toc.filter((item) => item.level > 1)) {
199
+ const link = el("a", heading.title);
200
+ link.href = route(current.id, heading.anchor);
201
+ link.style.paddingLeft = `${Math.max(0, heading.level - 2) * 12}px`;
202
+ $("#toc").append(link);
203
+ }
204
+ const siblings = site.documents.filter((doc) => doc.tab === activeTab);
205
+ const index = siblings.indexOf(current);
206
+ for (const [label, doc] of [
207
+ ["← 이전 문서", siblings[index - 1]],
208
+ ["다음 문서 →", siblings[index + 1]],
209
+ ]) {
210
+ if (!doc) {
211
+ $("#pagination").append(el("span"));
212
+ continue;
213
+ }
214
+ const link = el("a");
215
+ link.href = route(doc.id);
216
+ link.append(el("small", label), el("strong", doc.title));
217
+ $("#pagination").append(link);
218
+ }
219
+ attachFinder(
220
+ $("#page-search"),
221
+ $("#article"),
222
+ $("#page-count"),
223
+ $("#page-prev"),
224
+ $("#page-next"),
225
+ );
226
+ for (const section of document.querySelectorAll(".search-section"))
227
+ attachFinder(
228
+ section.querySelector("[data-section-search]"),
229
+ section.querySelector(".section-content"),
230
+ section.querySelector(".match-count"),
231
+ section.querySelector("[data-find-prev]"),
232
+ section.querySelector("[data-find-next]"),
233
+ );
234
+ if (pendingQuery) {
235
+ $(".document-find").open = true;
236
+ $("#page-search").value = pendingQuery;
237
+ $("#page-search").oninput();
238
+ pendingQuery = "";
239
+ }
240
+ if (anchor) {
241
+ const heading = [...$("#article").querySelectorAll("[id]")].find(
242
+ (node) => node.id === anchor,
243
+ );
244
+ requestAnimationFrame(() => heading?.scrollIntoView({ block: "start" }));
245
+ } else window.scrollTo(0, 0);
246
+ }
247
+
248
+ function renderResults() {
249
+ const query = $("#global-search").value;
250
+ const results = searchDocuments(site.documents, query);
251
+ $("#search-count").textContent = query.trim()
252
+ ? results.length
253
+ ? `${results.length}개 결과${results.length === 80 ? " (최대 80개 표시)" : ""}`
254
+ : "일치하는 내용이 없습니다."
255
+ : "한국어와 영문으로 모든 탭의 내용을 검색합니다.";
256
+ $("#results").replaceChildren();
257
+ for (const { doc, section } of results) {
258
+ const link = el("a", undefined, "result");
259
+ link.href = route(doc.id, section.anchor);
260
+ const title = el("strong", section.title);
261
+ const ranges = matchRanges(section.text, query);
262
+ const start = Math.max(0, (ranges[0]?.[0] || 0) - 45);
263
+ const snippet = el(
264
+ "p",
265
+ `${start ? "…" : ""}${section.text.slice(start, start + 180)}${section.text.length > start + 180 ? "…" : ""}`,
266
+ );
267
+ link.append(
268
+ el(
269
+ "small",
270
+ `${site.tabs.find((tab) => tab.slug === doc.tab).title} / ${doc.title}`,
271
+ ),
272
+ title,
273
+ snippet,
274
+ );
275
+ highlight(title, query);
276
+ highlight(snippet, query);
277
+ link.onclick = () => {
278
+ pendingQuery = query;
279
+ dialog.close();
280
+ if (location.hash === link.hash) render();
281
+ };
282
+ $("#results").append(link);
283
+ }
284
+ }
285
+
286
+ const openSearch = () => {
287
+ if (!site) return;
288
+ dialog.showModal();
289
+ $("#global-search").focus();
290
+ renderResults();
291
+ };
292
+ $("#open-search").onclick = openSearch;
293
+ $("#close-search").onclick = () => dialog.close();
294
+ $("#global-search").oninput = renderResults;
295
+ $("#global-search").onkeydown = (event) => {
296
+ if (event.key === "ArrowDown") {
297
+ event.preventDefault();
298
+ $("#results a")?.focus();
299
+ } else if (event.key === "Enter") $("#results a")?.click();
300
+ };
301
+ $("#results").onkeydown = (event) => {
302
+ if (!["ArrowDown", "ArrowUp"].includes(event.key)) return;
303
+ event.preventDefault();
304
+ const links = [...$("#results").children];
305
+ links[
306
+ (links.indexOf(document.activeElement) +
307
+ (event.key === "ArrowDown" ? 1 : -1) +
308
+ links.length) %
309
+ links.length
310
+ ]?.focus();
311
+ };
312
+ document.addEventListener("keydown", (event) => {
313
+ if ((event.metaKey || event.ctrlKey) && event.key.toLowerCase() === "k") {
314
+ event.preventDefault();
315
+ if (!dialog.open) openSearch();
316
+ }
317
+ });
318
+ dialog.addEventListener("click", (event) => {
319
+ if (event.target === dialog) {
320
+ const rect = dialog.getBoundingClientRect();
321
+ if (
322
+ event.clientX < rect.left ||
323
+ event.clientX > rect.right ||
324
+ event.clientY < rect.top ||
325
+ event.clientY > rect.bottom
326
+ )
327
+ dialog.close();
328
+ }
329
+ });
330
+ window.addEventListener("hashchange", () => {
331
+ if (site) render();
332
+ });
333
+ $(".skip-link").onclick = (event) => {
334
+ event.preventDefault();
335
+ $("#content").focus();
336
+ $("#content").scrollIntoView();
337
+ };
338
+ try {
339
+ const response = await fetch("./site.json");
340
+ if (!response.ok) throw new Error(`HTTP ${response.status}`);
341
+ site = await response.json();
342
+ $("#site-title").textContent = site.title;
343
+ render();
344
+ } catch (error) {
345
+ $("#article").replaceChildren(
346
+ el("h1", "문서를 불러오지 못했습니다"),
347
+ el("p", `정적 HTTP 서버에서 사이트를 열어주세요. ${error.message}`),
348
+ );
349
+ }
@@ -0,0 +1,68 @@
1
+ <!doctype html>
2
+ <html lang="ko">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <meta name="viewport" content="width=device-width,initial-scale=1" />
6
+ <meta name="color-scheme" content="light" />
7
+ <title>Safibook</title>
8
+ <link rel="stylesheet" href="./style.css" />
9
+ </head>
10
+ <body>
11
+ <a class="skip-link" href="#content">본문으로 이동</a>
12
+ <header>
13
+ <a class="brand" href="#/" aria-label="문서 홈"
14
+ ><span class="brand-icon">S</span
15
+ ><span id="site-title">Safibook</span></a
16
+ ><button id="open-search" class="search-trigger">
17
+ <span>⌕ &nbsp; 검색...</span><kbd>⌘ / Ctrl K</kbd></button
18
+ ><span class="header-label"></span>
19
+ </header>
20
+ <nav id="tabs" aria-label="문서 탭"></nav>
21
+ <div class="layout">
22
+ <aside class="sidebar">
23
+ <div class="eyebrow">DOCUMENTATION</div>
24
+ <nav id="documents" aria-label="문서 목록"></nav>
25
+ <div class="powered">Made with <strong>Safibook</strong></div>
26
+ </aside>
27
+ <main id="content" tabindex="-1">
28
+ <div id="breadcrumb"></div>
29
+ <details class="document-find">
30
+ <summary>이 문서에서 찾기</summary>
31
+ <div class="document-tools">
32
+ <label for="page-search">이 문서에서 찾기</label
33
+ ><input
34
+ id="page-search"
35
+ type="search"
36
+ placeholder="검색어 입력"
37
+ /><span id="page-count" aria-live="polite"></span
38
+ ><button id="page-prev" aria-label="이전 일치">↑</button
39
+ ><button id="page-next" aria-label="다음 일치">↓</button>
40
+ </div>
41
+ </details>
42
+ <article id="article"></article>
43
+ <nav id="pagination" aria-label="이전 다음 문서"></nav>
44
+ </main>
45
+ <aside class="toc">
46
+ <div class="eyebrow">이 페이지에서</div>
47
+ <nav id="toc" aria-label="목차"></nav>
48
+ </aside>
49
+ </div>
50
+ <dialog id="search-dialog" aria-labelledby="search-title">
51
+ <div class="dialog-head">
52
+ <label id="search-title" for="global-search">전체 문서 검색</label
53
+ ><button id="close-search" aria-label="검색 닫기">
54
+ 닫기 <kbd>Esc</kbd>
55
+ </button>
56
+ </div>
57
+ <input
58
+ id="global-search"
59
+ type="search"
60
+ placeholder="제목, 내용 또는 용어를 검색하세요"
61
+ autocomplete="off"
62
+ />
63
+ <p id="search-count" aria-live="polite"></p>
64
+ <div id="results"></div>
65
+ </dialog>
66
+ <script type="module" src="./app.js"></script>
67
+ </body>
68
+ </html>