3.5 巢狀資料夾與網址
NoteCraftApp 使用文件 第 3 章・撰寫筆記

3.5 撰寫筆記

巢狀資料夾與網址

筆記資料夾的階層會原樣對到網址。這頁說明檔案路徑怎麼變成 /notes/ 底下的網址,以及筆記之間怎麼互相連結。

本頁目錄
  1. 路徑與網址對照
  2. 檔名會被正規化
  3. 不想變成筆記的檔案
  4. 筆記之間互相連結

筆記資料夾裡的子資料夾不用攤平。每個 .md/.mdx 檔案相對筆記資料夾的路徑,去掉副檔名,就是它的網址。

路徑與網址對照

檔案網址
hello.mdx/notes/hello
guides/setup.mdx/notes/guides/setup
guides/oauth/flow.mdx/notes/guides/oauth/flow
guides/index.mdx/notes/guides
筆記資料夾 網址 notes/ ├── hello.mdx /notes/hello ├── my note.mdx /notes/my-note 空白換成 - ├── guides/ │ ├── index.mdx /notes/guides index 對到資料夾本身 │ ├── Setup.mdx /notes/guides/setup 轉小寫 │ └── oauth/ │ └── flow.mdx /notes/guides/oauth/flow └── 筆記/ └── 快取策略.mdx /notes/筆記/快取策略 中文照樣保留
資料夾階層原樣對到網址:檔案相對筆記資料夾的路徑去掉副檔名,就是 /notes/ 後面那一段;打底色的是正規化改到的字。

每個檔案的完整路徑本來就不會重複,所以不同資料夾裡同名的筆記不會互相衝突。

檔名會被正規化

網址裡的每一段會轉成小寫、空白換成 -,大部分標點符號會被移除;中文字照樣保留。

檔案網址
Guides/Setup.mdx/notes/guides/setup
my note.mdx/notes/my-note
筆記/快取策略.mdx/notes/筆記/快取策略

工作台側欄的資料夾樹顯示的是真實的資料夾與檔名,不受正規化影響。

不想變成筆記的檔案

筆記資料夾裡每個 .md/.mdx 預設都會變成筆記。草稿、範本、CHANGELOG.md 這類不想出現的,寫進 .notecraft/ignore.json:

.notecraft/ignore.json
{ "ignore": ["drafts/", "CHANGELOG.md", "**/*.private.md"] }

. 開頭的資料夾、node_modules/、dist/ 不用寫,本來就不讀。寫法與注意事項見排除檔案。

筆記之間互相連結

直接用相對路徑連到另一個 .md/.mdx 檔案:

guides/setup.md
下一步見 [OAuth 流程](./oauth/flow.mdx)。

連結會被改寫成 /notes/guides/oauth/flow,和在 GitHub、VS Code 裡點檔案的直覺一致。網址後面的 ?… 與 #… 會保留,所以 ./oauth/flow.mdx#pkce 會連到該篇的錨點。

連到被 ignore.json 排除的筆記時,連結照樣改寫,但那一頁不存在、點了會 404,build log 會提醒。

在 GitHub 上修改這一頁