標題列與頁尾連結
請使用 Quarto 原生導覽選項設定連結。Askr 負責外觀,不會另建連結清單。標題列提供快速入口;頁尾則讓讀者閱讀完畢後仍可前往專案、社群與維護資源。
原生設定
website:
navbar:
tools-collapse: true
tools:
- icon: github
href: https://github.com/your-organization/your-project
text: GitHub repository
aria-label: GitHub repository
page-footer:
left:
- icon: github
aria-label: GitHub repository
href: https://github.com/your-organization/your-project
- text: '<i class="bi bi-chat-dots" aria-hidden="true"></i> Community'
href: https://community.example.org/
center:
- text: '<i class="bi bi-book" aria-hidden="true"></i> Maintenance guide'
href: maintenance.qmd
- text: '<i class="bi bi-people" aria-hidden="true"></i> Contributing'
href: contributing.qmd
- text: '<i class="bi bi-file-earmark-text" aria-hidden="true"></i> 授權條款'
href: license.qmd
- text: '<i class="bi bi-journal-text" aria-hidden="true"></i> 第三方聲明'
href: THIRD_PARTY.md
right: "Your project's existing footer content"請將範例目的地替換為自己的連結。GitHub 會出現兩次,因為它們位於兩個不同的原生導覽區域;Askr 不會同步網址。圖示請使用 Bootstrap 圖示名稱,並為 text / aria-label 提供描述性文字。只有圖示的頁尾連結必須設定 aria-label:Quarto 會將該名稱套用至原生圖示。若社群連結不易辨識,請加上簡短的可見標籤,讓用途更清楚。
Quarto 1.10.18 的頁尾文字呈現方式會在同時設定時以 icon 取代相鄰文字,因此這些範例將裝飾性 Bootstrap 圖示放入原生 text 標記。aria-hidden 會讓可見標籤成為連結名稱。
設定 tools-collapse: true 時,空間不足的已撰寫工具會移到 Areas 面板。主題、Search 與選用的 Logout 仍留在標題列。設定為 false 時,工具會留在標題列;請控制數量,確保最窄的視窗也能容納。較長的頁尾標籤會換行,不會變成捲動列。連結仍依 Quarto 原生 href、target 與 rel 行為運作;Askr 不會強制在新分頁開啟。既有連結與建置資訊仍由作者設定。
專案授權條款與第三方聲明
請使用一般 page-footer 項目,將專案授權條款與第三方聲明放在既有的專案及貢獻連結旁。標籤與目的地應對應到實際發布的文件;Askr 不會替使用它的專案推測文件位置或選擇授權。展示網站連到 Askr 本身的 MIT 授權與資產聲明,這些不是安裝 Askr 的文件站所採用的授權條款。
建議用 license.qmd 作為閱讀頁面,直接包含唯一的授權來源,避免複製法律文字:
---
title: "授權條款"
---
下方是本專案的原始授權條款。
{{< include LICENSE >}}_quarto.yml 中的頁尾 href 以該 Quarto 專案為基準。license.qmd 與 THIRD_PARTY.md 會連到渲染後的 license.html 與 THIRD_PARTY.html,因此也要將兩個來源包含在專案的渲染範圍內。Quarto 會調整深層頁面的連結,例如 usage/header-footer.html 會連回 ../license.html 與 ../THIRD_PARTY.html。使用專案相對路徑,也能保留 /docs/ 這類部署前綴或 /v1.2/ 版本目錄,不必將這些目錄寫死在連結中。
原始 LICENSE 可另外提供下載連結。主機的內容類型與回應標頭會決定檔案開啟或下載,因此閱讀入口應連到渲染後的頁面。若另提供原始檔案連結,請將檔案明確加入專案資源:
project:
resources:
- LICENSE各語言若使用獨立專案,可有各自的閱讀頁面,但包含同一份授權來源。例如 zh-TW/license.qmd 使用 {{< include ../LICENSE >}},並說明法律文字保留原文。該專案的頁尾可連到此閱讀頁,以及上層網站共用的聲明頁:
website:
page-footer:
center:
- text: 授權條款
href: license.qmd
- text: 第三方聲明(英文)
href: ../THIRD_PARTY.html上層專案負責渲染 THIRD_PARTY.md。Quarto 也會依更深層的翻譯頁面調整相對路徑。若各語言另有自己撰寫的聲明,則分別連到各專案的來源。權威文件放在其他網站時,也可使用完整的 HTTPS 網址。既有 GitHub、貢獻及維護連結,以及附加的 Powered by Askr 致謝,都保留原本用途。
Powered by Askr
頁尾右側會包含 Powered by Askr · version。Askr 會將 Powered by Askr 連到文件網站,並將版本連到 GitHub Release。安裝的擴充套件 _extension.yml 才是版本依據,並非 askr-versions.json 或文件所用的套件版本。尚未發布的本機修改仍會顯示目前套件中繼資料的版本;這不能證明修改已發布。
若要隱藏此致謝:
askr:
footer:
credit: falseAskr 會附加致謝文字,不會取代右側原有內容。若作者沒有設定頁尾,Askr 會建立只含致謝文字的簡易頁尾;若停用致謝,則不會建立頁尾。Askr 不會產生或移除提交雜湊值。
選單、頁尾區域與其他原生選項請見 Quarto 導覽指南。