此文件頁面特定於 Scala 3,可能涵蓋 Scala 2 中沒有的新概念。除非另有說明,此頁面中的所有程式碼範例都假設您使用 Scala 3。
Scaladoc 讓您可以在文件中加入簡單的網誌。目前,它只提供基本功能。未來,我們計畫加入更多進階功能,例如標記或作者頁面。
網誌的處理方式與一般靜態網站略有不同。本文將協助您設定自己的網誌。
正確的目錄設定
所有網誌文章都必須放在 _blog/_posts
目錄下。
├── _blog
│ ├── _posts
│ │ └── 2016-12-05-implicit-function-types.md
│ └── index.html
如果存在 _blog
目錄,Scaladoc 就會載入網誌。
命名慣例
所有網誌文章檔名應以符合 YYYY-MM-DD
的數字格式日期開頭。範例名稱為 2015-10-23-dotty-compiler-bootstraps.md
。
頁面元資料
Scaladoc 中的網誌頁面支援 Yaml 前置資料,讓您可以指定將用於頁面中元資料的不同值。以下是可能的欄位
---
layout: <A reference to the layout page for the blog page>
author: <Name of the author of the page>
title: <Title of the page>
subTitle: <Subtitle of the page>
date: <Date of the creation of the page>, e.g. 2016-12-05
authorImg: <Link to the author's image>
---
<Content of your page>
您也可以在 Jekyll 文件網站 上找到更多關於前置資料的詳細資訊。
內容語法
請記住,您的網誌撰寫是使用 Markdown 完成的。您可以在 Markdown 指南 中找到更多關於語法的資訊。
網誌設定
在建立您的網誌時,Scaladoc 也允許您設定它。
為了修改網誌文件預設設定,使用者需要在 網誌的根目錄 中建立一個名為 blog.yml
的檔案。該檔案應包含使用者想要變更的參數。例如,如果使用者想要將輸入目錄變更為「my_posts」、輸出目錄變更為「my_docs」,並暫時隱藏網誌,他們可以建立一個包含以下內容的檔案
input: my_posts
output: my_docs
hidden: true
參數
input
:指定包含網誌文章 Markdown 檔案的目錄(預設:文件中的「_posts」)。
output
:指定將產生 HTML 頁面的資料夾(預設:target/docs 中的「blog」)。
hidden
:允許使用者暫時隱藏網誌(預設:false)。
若要變更這些設定,請建立一個包含參數的檔案,並將其儲存在網誌的根目錄中。下次建立網誌時,將使用新的設定。