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
# The directory containing this .scraps.toml is the wiki root: every *.md file
# under it (recursively) is a scrap. Top-level `static/` and the build output
# directory, and any entries whose name starts with `.`, are skipped
# automatically.
# The build output directory path relative to this .scraps.toml (optional, default=_site)
# output_dir = "_site"
# The site timezone (optional, default=UTC)
# timezone = "UTC"
# SSG (Static Site Generator) configuration section
# This section is required for build and serve commands
[]
# The site base url (required)
= "https://username.github.io/repository-name/"
# The site title (required)
= "My Site"
# The site language (compliant with iso639-1, default=en)
# lang_code = "en"
# The site description (optional)
# description = ""
# The site favicon in the form of png file URL (optional)
# favicon = ""
# The site color scheme (optional, default=os_setting, choices=os_setting or only_light or only_dark)
# color_scheme = "os_setting"
# Build a search index with the Fuse JSON and display search UI (optional, default=true, choices=true or false)
# build_search_index = true
# Scraps sort key choice on index page (optional, default=committed_date, choices=committed_date or linked_count)
# sort_key = "committed_date"
# Scraps pagination on index page(optional, default=no pagination)
# paginate_by = 20
# Lint rule configuration (optional)
# Default rules report defects in any wiki and are always on. An opt-in rule
# checks a policy this wiki chooses, in its own [lint.<rule>] section. Section
# presence enables the rule (enabled defaults to true); set enabled = false to
# disable while preserving the rule's parameters.
# stale_by_git: flag scraps whose latest git commit is older than the threshold.
# Opt-in because how old is stale is for each wiki to decide.
# [lint.stale_by_git]
# enabled = true
# threshold_days = 180
# unportable_key: flag scraps whose file path does not port across filesystems
# (names Windows rejects, paths that differ only in case).
# Opt-in because where a wiki must port to is for each wiki to decide.
# [lint.unportable_key]
# enabled = true