mhbasics/_config.yml at main · MHCommunity/mhbasics · 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
title: Mousehunt Guide

permalink: pretty
exclude: [
  ".github/",
  ".devcontainer/",
  ".vscode/",
  "node_modules/",
  ".gitignore",
  ".prettierignore",
  ".prettierrc",
  ".stylelintrc.json",
  "CONTRIBUTING.md",
  "docker-compose.yml",
  "Dockerfile",
  "Gemfile",
  "Gemfile.lock",
  "guide.gemspec",
  "LICENSE.md",
  "package.json",
  "package-lock.json",
  "Rakefile",
  "README.md",
  "Template.md"
]

include:
 - _pages

# enable or disable the site search
# supports true (default) or false
search_enabled: true

search:
  # split pages into sections that can be searched individually
  # supports 1 - 6, default: 2
  heading_level: 3
  # maximum amount of previews per search result
  # default: 3
  previews: 3
  # maximum amount of words to display before a matched word in the preview
  # default: 5
  preview_words_before: 5
  # maximum amount of words to display after a matched word in the preview
  # default: 10
  preview_words_after: 10
  # set the search token separator
  # default: /[\s\-/]+/
  # example: enable support for hyphenated search words
  tokenizer_separator: /[\s/]+/
  # display the relative url in search results
  # supports true (default) or false
  rel_url: true
  # enable or disable the search button that appears in the bottom right corner of every page
  # supports true or false (default)
  button: false

# aux links for the upper right navigation
aux_links:
  "mouse.rip":
    - "https://mouse.rip"
  "Discord":
    - "https://discordapp.com/mousehunt"

# makes aux links open in a new tab. default is false
aux_links_new_tab: true

# heading anchor links appear on hover over h1-h6 tags in page content
# allowing users to deep link to a particular heading on a page.
#
# supports true (default) or false
heading_anchors: true

# back to top link
back_to_top: true
back_to_top_text: "back to top"

# color scheme supports "light" (default) and "dark"
color_scheme: dark

callouts_level: quiet # or loud
callouts:
  highlight:
    color: yellow
  important:
    title: Important
    color: blue
  new:
    title: New
    color: green
  note:
    title: Note
    color: purple
  warning:
    title: Warning
    color: red