此文档页面特定于 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 文件的目录(默认:“docs”中的“_posts”)。
output
:指定将生成 HTML 页面的文件夹(默认:“target/docs”中的“blog”)。
hidden
:允许用户暂时隐藏博客(默认:“false”)。
要更改这些设置,请创建一个包含参数的文件,并将其保存在博客的根目录中。下次构建博客时,将使用新设置。