@limcpf/everything-is-a-markdown 0.6.6 → 0.6.8

package/README.ko.md

@@ -3,11 +3,13 @@
 언어: [English](README.md) | **한국어**
 
 Everything-Is-A-Markdown은 로컬 Markdown 볼트를 정적 웹사이트로 빌드해, 폴더/파일 탐색 구조를 유지한 채 공개할 수 있게 해주는 CLI 도구입니다.
+공개 URL은 `prefix` 기준으로 생성되고, 사이드바 폴더 구조는 실제 파일 경로가 아니라 `category_path` 기준으로 만들어집니다.
 
 ## 이 앱은 무엇을 하나요
 
 - Markdown 볼트에서 정적 문서/블로그 사이트를 생성
 - `publish: true` 문서만 선택적으로 공개
+- 공개 문서는 `prefix`와 `category_path`를 필수로 사용
 - 비공개 노트와 공개 콘텐츠 분리
 
 ## Obsidian 사용자에게 특히 잘 맞습니다
@@ -73,6 +75,10 @@ const config = {
   vaultDir: "./vault",
   outDir: "./dist",
   staticPaths: ["assets", "public/favicon.ico"],
+  pinnedMenu: {
+    label: "NOTICE",
+    categoryPath: "announcements",
+  },
   seo: {
     siteUrl: "https://example.com",
     pathBase: "/blog",
@@ -97,6 +103,12 @@ export default config;
 - 지정한 경로의 파일들을 `dist`에 같은 상대 경로로 복사
 - 예: 볼트 `assets/og.png` -> `dist/assets/og.png`
 
+`pinnedMenu`:
+
+- `categoryPath`: 문서 frontmatter `category_path` prefix 기준으로 가상 폴더를 구성
+- `sourceDir`: 기존 파일 경로 prefix 기준
+- 둘 다 있으면 `categoryPath`가 우선
+
 `seo.pathBase`:
 
 - 서브패스 배포(예: `/blog`)를 정식 지원합니다.
@@ -123,7 +135,9 @@ bun run build -- --vault ./test-vault --out ./dist
   이 값이 `true`인 문서만 빌드 결과에 포함됩니다.
 - `prefix: "A-01"`  
   문서의 공개 식별자이자 라우트(`/A-01/`) 기준입니다.  
-  `publish: true`인데 `prefix`가 없으면 빌드 경고를 출력하고 문서를 제외합니다.
+- `category_path: "engineering/blog/frontend"`  
+  사이드바 폴더 구조 기준입니다.
+  `publish: true`인데 `prefix`나 `category_path`가 없으면 빌드 경고를 출력하고 문서를 제외합니다.
 
 선택:
 
@@ -150,6 +164,7 @@ bun run build -- --vault ./test-vault --out ./dist
 ---
 publish: true
 prefix: "DEV-01"
+category_path: "guides/setup"
 branch: dev
 title: Setup Guide
 date: "2024-09-15"
@@ -180,6 +195,25 @@ title: Work In Progress
 ---
 ```
 
+## 위키링크 지원
+
+위키링크는 아래 순서로 해석됩니다.
+
+1. 볼트 기준 상대 경로(확장자 `.md` 제외)
+2. `prefix`
+3. `title` 정확히 일치
+4. 파일 stem(유일할 때만)
+
+예시:
+
+- `[[posts/2024/setup-guide]]`
+- `[[BC-VO-02]]`
+- `[[Building a File-System Blog]]`
+- `[[setup-guide]]`
+- `[[Building a File-System Blog|먼저 읽기]]`
+
+대상을 찾지 못하거나 같은 `title`을 가진 게시 문서가 여러 개면 링크로 바꾸지 않고 빌드 warning을 출력합니다.
+
 ## Mermaid 다이어그램 지원
 
 코드 블록의 언어를 `mermaid`로 작성하면 브라우저에서 Mermaid 다이어그램으로 렌더링합니다.
@@ -197,6 +231,34 @@ Mermaid fence는 일반 코드 블록 UI와 분리된 전용 컨테이너(`.merm
 본문 이미지도 동일한 폭 정책을 적용해 글 읽기 흐름을 유지합니다.
 설정에서 Mermaid를 비활성화하거나 CDN 로드가 실패하면, 같은 컨테이너 안에서 소스 코드 텍스트를 유지하고 하단에 경고 메시지를 표시합니다.
 
+## 본문 이미지 레이아웃
+
+본문 이미지는 이제 방향에 따라 표시 폭을 다르게 조정합니다.
+
+- 가로 이미지는 기본 읽기 폭을 유지합니다.
+- 세로 이미지는 더 좁은 최대 폭을 적용해 본문을 과하게 압도하지 않게 합니다.
+- 정사각형에 가까운 이미지는 중간 폭을 사용합니다.
+
+`markdown.images: "keep"`로 로컬 Markdown 이미지를 허용하면, 이미지만 있는 문단은 자동으로 `figure.content-image` 래퍼로 승격됩니다.
+고정 비율이나 자르기 방식을 직접 지정하고 싶을 때는 raw HTML figure 유틸리티를 사용할 수 있습니다.
+
+예시:
+
+```html
+<figure class="image-frame ratio-4x3 fit-cover">
+  <img src="/assets/hero.jpg" alt="Cover-framed image" />
+</figure>
+
+<figure class="image-frame ratio-4x5 fit-contain">
+  <img src="/assets/poster.jpg" alt="Contain-framed image" />
+</figure>
+```
+
+지원 유틸리티:
+
+- 비율: `ratio-16x9`, `ratio-4x3`, `ratio-3x2`, `ratio-4x5`
+- 맞춤 방식: `fit-cover`, `fit-contain`
+
 `blog.config.ts`에서 설정:
 
 ```ts