@tenjuu99/blog 0.3.4 → 0.3.5

package/docs/spec.md

@@ -129,7 +129,7 @@ url: /custom-url
 |--------|-------------|------|
 | `name` | ファイル名（拡張子なし） | ページの内部名 |
 | `title` | `name` の値 | ページタイトル |
-| `url` | `/${name}` | URLパス |
+| `url` | `/${name}` | URLパス（出力先も決定する。後述） |
 | `description` | 本文先頭150文字 | ページ説明 |
 | `og_description` | `description` と同じ | OGP説明文 |
 | `published` | `"1970-01-01"` | 公開日 |
@@ -146,9 +146,41 @@ url: /custom-url
 | `markdown` | 解析後のHTML | Markdown変換後のHTML |
 | `markdown_not_parsed` | フロントマター除去後 | 変換前のMarkdown |
 | `full_url` | 自動生成 | 完全なURL |
-| `__output` | 自動生成 | 出力ファイルパス |
+| `__output` | 自動生成 | 出力ファイルパス（`url` から導出） |
 | `__filetype` | 拡張子 | 元ファイルの拡張子 |
 
+### `url` と出力先の関係
+
+`url` フィールドはリンクの `href` に使われるだけでなく、**出力ファイルパス（`__output`）の導出元**にもなっています。
+
+| `url` の形式 | `__output` |
+|-------------|-----------|
+| `/foo/bar`（末尾スラッシュなし） | `/foo/bar.html` |
+| `/foo/bar/`（末尾スラッシュあり） | `/foo/bar/index.html` |
+
+フロントマターで `url` を上書きすると `__output` も再計算されるため、ファイルの物理的な配置とは無関係に出力先を変更できます。
+
+```markdown
+---
+url: /book/new/book
+---
+```
+
+この場合、ファイルが `src/pages/book/new_book.md` であっても、出力先は `dist/book/new/book.html` になります。
+
+**例外**: ファイル名が `index` の場合は `__output = /index.html` 固定（`url` に関係なし）。また、カテゴリーパッケージの仮想ページのように `__output` を明示的に設定するケースでは、この導出は行われません。
+
+### URLの末尾スラッシュ規約
+
+S3+CDN 等のファイルシステムベースのホスティングでは、`/book` というURLが `book.html` を指すのか `book/index.html` を指すのかをURLだけから判断できません。これを避けるため、以下の規約を推奨します。
+
+| ページ種別 | URL形式 | 出力先 |
+|-----------|---------|-------|
+| アイテム系（記事・個別ページ） | 末尾スラッシュなし `/book/foo` | `dist/book/foo.html` |
+| リスト系（一覧・カテゴリー・ページネーション） | 末尾スラッシュあり `/book/` | `dist/book/index.html` |
+
+リスト系ページを作る場合は、フロントマターで `url` を末尾スラッシュつきで指定するか、ファイル名を `index.md` にします。カテゴリーパッケージの仮想ページはこの規約に従い、`url` に末尾スラッシュを付与しています。
+
 ### データ型の記述
 
 フロントマター内のデータ型:

package/lib/pageData.js

@@ -56,7 +56,11 @@ const parse = (content, name, ext) => {
     metaDataMerged.url = '/preview' + metaDataMerged.url
   }
   metaDataMerged.full_url = fullUrl(metaDataMerged)
-  metaDataMerged['__output'] = name === 'index' ? '/index.html' : `${metaDataMerged.url}.${metaDataMerged.ext}`
+  metaDataMerged['__output'] = name === 'index'
+    ? '/index.html'
+    : metaDataMerged.url.endsWith('/')
+      ? `${metaDataMerged.url}index.html`
+      : `${metaDataMerged.url}.${metaDataMerged.ext}`
 
   return metaDataMerged
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tenjuu99/blog",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "blog template",
   "main": "index.js",
   "scripts": {

package/packages/category/helper/categoryIndexer.js

@@ -44,7 +44,7 @@ function buildVirtualPage(url, categoryData, children, currentPage, totalPages,
 
   const page = {
     name: pageName,
-    url: url,
+    url: url + '/',
     __output: `${url}/index.html`,
     title: categoryData.title,
     template: categoryConfig.template || 'category.html',
@@ -65,7 +65,7 @@ function buildVirtualPage(url, categoryData, children, currentPage, totalPages,
     og_description: `${categoryData.title} カテゴリーのページ一覧`,
     __filetype: 'md',
     markdown_not_parsed: '',
-    full_url: `${config.url_base || 'http://localhost:8000'}${url}`,
+    full_url: `${config.url_base || 'http://localhost:8000'}${url}/`,
     category_pages: [],
     category_current_page: currentPage,
     category_total_pages: totalPages,
@@ -100,7 +100,7 @@ function generateCategoryPages(allData, categoryConfig, config) {
 
   for (const [url, categoryData] of Object.entries(tree)) {
     const children = Object.entries(categoryData.children).map(([childUrl, childNode]) => ({
-      url: childUrl,
+      url: childUrl + '/',
       title: childNode.title,
     }))