openyellowos.github.io/_config.yml at main · openyellowos/openyellowos.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
#--------------------------
# just-the-docsのconfig用ドキュメント
# https://just-the-docs.github.io/just-the-docs/docs/configuration/

#--------------------------
# テーマ https://just-the-docs.github.io/just-the-docs/docs/configuration/
# $ bundle info --path just-the-docs # テーマのディレクトリを調べる際のコメント
theme: just-the-docs

#--------------------------
# jekyll用
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com

# プロダクト説明
title: open.Yellow.os リファレンス
email:
description: >- # this means to ignore newlines until "baseurl:"
  国産Linux open.Yellow.osのリファレンス、サポートページです。

#--------------------------
# 画像周り
logo: "/assets/images/product-logo.png"
favicon_ico: "/assets/images/favicon.ico"

#--------------------------
# 検索機能周り
#
# rakeの実行が必要なため注意：bundle exec just-the-docs rake search:init
search_enabled: true

# -------theme側のドキュメント
# Set the search token separator
# Default: /[\s\-/]+/
# Example: enable support for hyphenated search words
# search.tokenizer_separator: /[\s/]+/
# -------デフォルトでは、-と空白スペースの扱いが同一
search.tokenizer_separator: /[\s/]+/

# 日本語検索は一工夫必要
# https://easyramble.com/japanese-regex-with-ruby-oniguruma.html
# japanese_regex = /\A(?:\p{Hiragana}|\p{Katakana}|[ー－]|[一-龠々])+\z/

# 画面に検索ボタンを表示するか
search.button: true

#--------------------------
# 図形を書ける機能は必要になってから
# mermaid:
#  version: "9.1.3"

#--------------------------
# 使用したプラグインの紹介導線は設定
aux_links:
  "Just the Docs on GitHub":
    - "//github.com/just-the-docs/just-the-docs"
aux_links_new_tab: false

#--------------------------
# ヘッダー
# autor linkは一旦不要と判断

#--------------------------
# フッター周りの設定
footer_content: "Copyright &copy; 2023 open.Yellow.os Team"
# 最終更新日
last_edit_timestamp: true # 各ページmdのfrontmatterに`last_modified_date`を定義する
last_edit_time_format: "%Y-%m-%d at %H:%M"

# GitHub周りは一旦無しで
# gh_edit_link: true # show or hide edit this page link
# gh_edit_link_text: "Edit this page on GitHub."
# gh_edit_repository: "https://github.com/just-the-docs/just-the-docs" # the github URL for your repo
# gh_edit_branch: "main" # the branch that your docs is served from
# gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

# heading_anchors: true
# カラーテーマ(デフォルトのlightを指定 目に優しい白に)
color_scheme: light

# Callouts周り(Warning、Info周りの補足の色)
# テーマ上機能を有効にするには、_sass/custom/setup.scssにpink各種の追加必須
callouts:
  warning:
    title: 注意点
    color: yellow
  danger:
    title: 要注意
    color: pink
  info:
    title: 補足
    color: blue

# アカウント周り
twitter_username: twitter-name
github_username:  github-name

# プラグイン
plugins:
  - jekyll-sitemap