Skip to content

Commit 00c6026

Browse files
Update scaladoc in ru (#2837)
Co-authored-by: Dima Kotobotov <[email protected]>
1 parent 78b8cb9 commit 00c6026

File tree

3 files changed

+207
-83
lines changed

3 files changed

+207
-83
lines changed

_ru/scala3/guides/scaladoc/blog.md

Lines changed: 58 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,16 @@ previous-page: static-site
88
next-page: site-versioning
99
---
1010

11-
Scaladoc позволяет включить в документацию простой блог.
12-
На данный момент предоставляются только основные функции.
11+
Scaladoc позволяет включить в документацию простой блог.
12+
На данный момент предоставляются только основные функции.
1313
В будущем мы планируем включить более продвинутые функции, такие как теги или авторские страницы.
1414

15-
К блогу относятся немного иначе, чем к обычным статическим сайтам.
15+
К блогу относятся немного иначе, чем к обычным статическим сайтам.
1616
Эта статья поможет вам создать свой собственный блог.
1717

1818
## Правильная настройка каталога
1919

20-
Сообщения в блоге должны быть помещены в каталог `_blog/_posts`.
21-
20+
Статьи в блоге должны быть помещены в каталог `_blog/_posts`.
2221

2322
```
2423
├── _blog
@@ -31,5 +30,58 @@ Scaladoc загружает блог, если существует катало
3130

3231
## Соглашение об именовании
3332

34-
Все имена файлов сообщений блога должны начинаться с даты в числовом формате, соответствующем `YYYY-MM-DD`.
33+
Все имена файлов сообщений блога должны начинаться с даты в числовом формате, соответствующем `YYYY-MM-DD`.
3534
Пример имени - `2022-06-17-dotty-compiler-bootstraps.md`.
35+
36+
## Метаданные страницы
37+
38+
Страницы блога в scaladoc поддерживают [Yaml Frontmatter](https://assemble.io/docs/YAML-front-matter.html),
39+
что позволяет указывать различные значения, которые будут использоваться для метаданных на вашей странице.
40+
Вот возможные поля:
41+
42+
```
43+
---
44+
layout: <Ссылка на макет страницы для страницы блога>
45+
author: <Автор страницы>
46+
title: <Заголовок страницы>
47+
subTitle: <Подзаголовок страницы>
48+
date: <Дата создания страницы>, например, 2016-12-05
49+
authorImg: <Ссылка на картинку автора>
50+
---
51+
<Содержимое страницы>
52+
```
53+
54+
Вы также можете найти более подробную информацию о метаданных [на сайте документации Jekyll](https://jekyllrb.com/docs/front-matter/).
55+
56+
## Синтаксис содержимого
57+
58+
Имейте в виду, что для записи вашего блога необходимо использовать формат Markdown.
59+
Более детальная информация о синтаксисе доступна в [Руководстве по Markdown](https://www.markdownguide.org/basic-syntax/).
60+
61+
## Конфигурация блога
62+
63+
Scaladoc позволяет настраивать блог, при его создании.
64+
65+
Чтобы изменить настройки документации блога по умолчанию,
66+
пользователям необходимо создать файл с именем `blog.yml` в **корневом каталоге блога**.
67+
Этот файл должен содержать параметры, которые пользователь хочет изменить.
68+
Например, если пользователь хочет изменить исходный каталог на "my_posts",
69+
исходящий каталог на "my_docs" и временно скрыть блог,
70+
то можно создать файл со следующим содержимым:
71+
72+
```
73+
input: my_posts
74+
output: my_docs
75+
hidden: true
76+
```
77+
78+
### Параметры:
79+
80+
`input`: указывает каталог, содержащий markdown-файлы для постов блога (по умолчанию: "\_posts" в "docs").
81+
82+
`output`: указывает папку, в которой будут созданы HTML-страницы (по умолчанию: "blog" в "target/docs").
83+
84+
`hidden`: позволяет пользователям временно скрывать блог (по умолчанию: "false").
85+
86+
Чтобы изменить эти настройки, создайте файл с параметрами и сохраните его в корневом каталоге блога.
87+
При следующей сборке блога будут использоваться новые параметры.

0 commit comments

Comments
 (0)