Skip to content

Commit 51e70bc

Browse files
TechnicJelleChicken
TechnicJelle
and
Chicken
authored
Added the configs to the wiki & Highlight linked headings (#139)
Co-authored-by: Antti Ellilä <antti@antti.codes>
1 parent 253b0b4 commit 51e70bc

File tree

14 files changed

+762
-19
lines changed

14 files changed

+762
-19
lines changed

‎Gemfile‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ gem "jekyll", "~> 4.3" # installed by `gem jekyll`
55

66
gem "just-the-docs", "0.10.1" # pinned to the current release
77
# gem "just-the-docs" # always download the latest release
8+
9+
gem 'jekyll-relative-links'

‎Gemfile.lock‎

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ GEM
44
addressable (2.8.7)
55
public_suffix (>= 2.0.2, < 7.0)
66
base64 (0.3.0)
7-
bigdecimal (3.2.2)
7+
bigdecimal (3.3.1)
88
colorator (1.1.0)
99
concurrent-ruby (1.3.5)
1010
csv (3.3.5)
@@ -17,16 +17,16 @@ GEM
1717
ffi (1.17.2-x86_64-darwin)
1818
ffi (1.17.2-x86_64-linux-gnu)
1919
forwardable-extended (2.6.0)
20-
google-protobuf (4.31.1-arm64-darwin)
20+
google-protobuf (4.33.1-arm64-darwin)
2121
bigdecimal
2222
rake (>= 13)
23-
google-protobuf (4.31.1-x64-mingw-ucrt)
23+
google-protobuf (4.33.1-x64-mingw-ucrt)
2424
bigdecimal
2525
rake (>= 13)
26-
google-protobuf (4.31.1-x86_64-darwin)
26+
google-protobuf (4.33.1-x86_64-darwin)
2727
bigdecimal
2828
rake (>= 13)
29-
google-protobuf (4.31.1-x86_64-linux-gnu)
29+
google-protobuf (4.33.1-x86_64-linux-gnu)
3030
bigdecimal
3131
rake (>= 13)
3232
http_parser.rb (0.8.0)
@@ -53,13 +53,15 @@ GEM
5353
webrick (~> 1.7)
5454
jekyll-include-cache (0.2.1)
5555
jekyll (>= 3.7, < 5.0)
56+
jekyll-relative-links (0.7.0)
57+
jekyll (>= 3.3, < 5.0)
5658
jekyll-sass-converter (3.1.0)
5759
sass-embedded (~> 1.75)
5860
jekyll-seo-tag (2.8.0)
5961
jekyll (>= 3.8, < 5.0)
6062
jekyll-watch (2.2.1)
6163
listen (~> 3.0)
62-
json (2.13.2)
64+
json (2.16.0)
6365
just-the-docs (0.10.1)
6466
jekyll (>= 3.8.5)
6567
jekyll-include-cache
@@ -77,21 +79,16 @@ GEM
7779
pathutil (0.16.2)
7880
forwardable-extended (~> 2.6)
7981
public_suffix (6.0.2)
80-
rake (13.3.0)
82+
rake (13.3.1)
8183
rb-fsevent (0.11.2)
8284
rb-inotify (0.11.1)
8385
ffi (~> 1.0)
84-
rexml (3.4.2)
85-
rouge (4.6.0)
86+
rexml (3.4.4)
87+
rouge (4.6.1)
8688
safe_yaml (1.0.5)
87-
sass-embedded (1.89.2-arm64-darwin)
88-
google-protobuf (~> 4.31)
89-
sass-embedded (1.89.2-x64-mingw-ucrt)
90-
google-protobuf (~> 4.31)
91-
sass-embedded (1.89.2-x86_64-darwin)
92-
google-protobuf (~> 4.31)
93-
sass-embedded (1.89.2-x86_64-linux-gnu)
89+
sass-embedded (1.94.2)
9490
google-protobuf (~> 4.31)
91+
rake (>= 13)
9592
terminal-table (3.0.2)
9693
unicode-display_width (>= 1.1.1, < 3)
9794
unicode-display_width (2.6.0)
@@ -105,7 +102,8 @@ PLATFORMS
105102

106103
DEPENDENCIES
107104
jekyll (~> 4.3)
105+
jekyll-relative-links
108106
just-the-docs (= 0.10.1)
109107

110108
BUNDLED WITH
111-
2.3.9
109+
2.3.27

‎_config.yml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,7 @@ exclude:
2222

2323
sass:
2424
quiet_deps: true # https://github.com/just-the-docs/just-the-docs/issues/1541
25-
silence_deprecations: ['import'] # https://github.com/just-the-docs/just-the-docs/issues/1607
25+
silence_deprecations: ['import'] # https://github.com/just-the-docs/just-the-docs/issues/1607
26+
27+
plugins:
28+
- jekyll-relative-links

‎_sass/custom/custom.scss‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,3 +119,68 @@ th {
119119
margin-left: calc( (100% - #{$page-width}) / 2 + #{$sidebar-width} );
120120
}
121121
}
122+
123+
h2, h3 {
124+
scroll-margin-top: 1em;
125+
}
126+
127+
// Highlight linked headings -->
128+
h2:not(:has(> code)):target,
129+
h3:not(:has(> code)):target {
130+
animation: highlightTexts 3s ease-out;
131+
}
132+
133+
@keyframes highlightTexts {
134+
from {
135+
text-shadow:
136+
0 0 2em rgba(170, 170, 255, 1.0),
137+
0 0 1em rgba(170, 170, 255, 1.0),
138+
0 0 0.1em rgba(170, 170, 255, 1.0);
139+
}
140+
to {
141+
box-shadow: 0 0 0em rgba(255, 255, 170, 0.0);
142+
}
143+
}
144+
145+
h2:target > code,
146+
h3:target > code {
147+
animation: highlightConfigs 3s ease-out;
148+
}
149+
150+
@keyframes highlightConfigs {
151+
from {
152+
box-shadow: 0 0 1em 0 rgba(170, 170, 255, 1.0);
153+
}
154+
to {
155+
box-shadow: 0 0 0em 0 rgba(255, 255, 170, 0.0);
156+
}
157+
}
158+
// <-- Highlight linked headings
159+
160+
section.config-indent {
161+
--indent-size: 2em;
162+
163+
&::before, &::after {
164+
position: relative;
165+
font-family: monospace;
166+
left: calc(-1 * var(--indent-size) - 0.5ch); //-0.5ch to center the line neatly between the {}'s
167+
}
168+
169+
&::before { content: "{"; }
170+
&::after { content: "}"; }
171+
172+
& :first-child { margin-top: 0; }
173+
& :last-child { margin-bottom: 0; }
174+
175+
padding-left: var(--indent-size);
176+
177+
--bracket-height: 2em;
178+
border-left: 1px solid transparent;
179+
border-image: linear-gradient(to bottom,
180+
transparent var(--bracket-height),
181+
grey var(--bracket-height),
182+
grey calc(100% - var(--bracket-height)),
183+
transparent calc(100% - var(--bracket-height))
184+
);
185+
border-image-slice: 1;
186+
}

‎wiki/configs/Core.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
layout: page
3+
title: Core
4+
parent: Configs
5+
grand_parent: Wiki
6+
nav_order: 1
7+
---
8+
9+
# Core-Config
10+
11+
> **Info:**
12+
> When a "default" is mentioned for any option, it is meant that if the option is commented out, that is what BlueMap will use.
13+
> This may not be the same as the option that is pre-filled-in.
14+
{: .info }
15+
16+
## `accept-download`
17+
By changing this setting to `true` you are indicating that you have accepted [Mojang's EULA](https://account.mojang.com/documents/minecraft_eula),
18+
you confirm that you own a license to Minecraft (Java Edition)
19+
and you agree that BlueMap will download and use a minecraft-client file (depending on the minecraft-version)
20+
from [Mojang's servers](https://piston-meta.mojang.com/mc/game/version_manifest.json) for you.
21+
This file contains resources that belong to Mojang and you must not redistribute it or do anything else that is not compliant with mojang's EULA.
22+
23+
BlueMap uses resources in this file to generate the 3D-models used for the map and texture them. (BlueMap will not work without those resources.)
24+
25+
## `data`
26+
The folder where BlueMap saves data-files it needs during runtime, or to save e.g. the render-progress to resume it later.
27+
28+
_Default is_ `"bluemap"`
29+
30+
## `render-thread-count`
31+
This changes the amount of threads that BlueMap will use to render the maps.
32+
A higher value can improve render-speed, but could impact performance on the host machine.
33+
This should be always below or equal to the number of available processor-cores.
34+
35+
Zero or a negative value means the amount of available processor-cores subtracted by the value.
36+
(So a value of -2 with 6 cores results in 4 render-processes)
37+
38+
_Default varies per machine_
39+
40+
## `scan-for-mod-resources`
41+
Controls whether BlueMap should try to find and load mod-resources and datapacks from the server/world-directories.
42+
43+
_Default is_ `true`
44+
45+
## `metrics`
46+
If this is `true`, BlueMap might send really basic metrics reports containing only the implementation-type and the version that is being used to [metrics.bluecolored.de/bluemap](https://metrics.bluecolored.de/)
47+
48+
This allows me to track the basic usage of BlueMap and helps me stay motivated to further develop this tool!
49+
Please leave it on :)
50+
51+
An example report looks like this: `{"implementation":"bukkit","version":"5.13","mcVersion":"?"}`
52+
53+
_Default is_ `true`
54+
55+
## `log`
56+
Config-section for debug-logging
57+
58+
<section markdown="1" class="config-indent">
59+
60+
### `file`
61+
The file where the debug-log will be written to.
62+
Comment out to disable debug-logging completely.
63+
64+
[Java String formatting syntax](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html) can be used to add time.
65+
66+
_Default is no logging_
67+
68+
### `append`
69+
Whether the logger should append to an existing file, or overwrite it
70+
71+
_Default is_ `false`
72+
73+
</section>

0 commit comments

Comments
 (0)