Scaladoc позволяет включить в документацию простой блог. На данный момент предоставляются только основные функции. В будущем мы планируем включить более продвинутые функции, такие как теги или авторские страницы.
К блогу относятся немного иначе, чем к обычным статическим сайтам. Эта статья поможет вам создать свой собственный блог.
Правильная настройка каталога
Статьи в блоге должны быть помещены в каталог _blog/_posts.
├── _blog
│ ├── _posts
│ │ └── 2016-12-05-implicit-function-types.md
│ └── index.html
Scaladoc загружает блог, если существует каталог _blog.
Соглашение об именовании
Все имена файлов сообщений блога должны начинаться с даты в числовом формате, соответствующем YYYY-MM-DD.
Пример имени - 2022-06-17-dotty-compiler-bootstraps.md.
Метаданные страницы
Страницы блога в scaladoc поддерживают Yaml Frontmatter, что позволяет указывать различные значения, которые будут использоваться для метаданных на вашей странице. Вот возможные поля:
---
layout: <Ссылка на макет страницы для страницы блога>
author: <Автор страницы>
title: <Заголовок страницы>
subTitle: <Подзаголовок страницы>
date: <Дата создания страницы>, например, 2016-12-05
authorImg: <Ссылка на картинку автора>
---
<Содержимое страницы>
Вы также можете найти более подробную информацию о метаданных на сайте документации Jekyll.
Синтаксис содержимого
Имейте в виду, что для записи вашего блога необходимо использовать формат Markdown. Более детальная информация о синтаксисе доступна в Руководстве по Markdown.
Конфигурация блога
Scaladoc позволяет настраивать блог, при его создании.
Чтобы изменить настройки документации блога по умолчанию,
пользователям необходимо создать файл с именем blog.yml в корневом каталоге блога.
Этот файл должен содержать параметры, которые пользователь хочет изменить.
Например, если пользователь хочет изменить исходный каталог на “my_posts”,
исходящий каталог на “my_docs” и временно скрыть блог,
то можно создать файл со следующим содержимым:
input: my_posts
output: my_docs
hidden: true
Параметры:
input: указывает каталог, содержащий markdown-файлы для постов блога (по умолчанию: “_posts” в “docs”).
output: указывает папку, в которой будут созданы HTML-страницы (по умолчанию: “blog” в “target/docs”).
hidden: позволяет пользователям временно скрывать блог (по умолчанию: “false”).
Чтобы изменить эти настройки, создайте файл с параметрами и сохраните его в корневом каталоге блога. При следующей сборке блога будут использоваться новые параметры.