Skip to content

Commit decde27

Browse files
authored
docs: split up quicktips (#584)
until now, all features were listed under quicktips. for a better overview and in preparation for further descriptions, the pages will be split into quicktips and features.
1 parent b52ab77 commit decde27

22 files changed

+119
-203
lines changed

Gemfile.lock

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ GEM
2525
ethon (0.14.0)
2626
ffi (>= 1.15.0)
2727
eventmachine (1.2.7)
28+
eventmachine (1.2.7-x64-mingw32)
2829
execjs (2.8.1)
2930
faraday (1.7.0)
3031
faraday-em_http (~> 1.0)
@@ -46,6 +47,7 @@ GEM
4647
faraday-patron (1.0.0)
4748
faraday-rack (1.0.0)
4849
ffi (1.15.3)
50+
ffi (1.15.3-x64-mingw32)
4951
forwardable-extended (2.6.0)
5052
gemoji (3.0.1)
5153
github-pages (218)
@@ -229,6 +231,8 @@ GEM
229231
nokogiri (1.12.5)
230232
mini_portile2 (~> 2.6.1)
231233
racc (~> 1.4)
234+
nokogiri (1.12.5-x64-mingw32)
235+
racc (~> 1.4)
232236
octokit (4.21.0)
233237
faraday (>= 0.9)
234238
sawyer (~> 0.8.0, >= 0.5.3)
@@ -263,18 +267,24 @@ GEM
263267
ethon (>= 0.9.0)
264268
tzinfo (1.2.9)
265269
thread_safe (~> 0.1)
270+
tzinfo-data (1.2021.5)
271+
tzinfo (>= 1.0.0)
266272
unf (0.1.4)
267273
unf_ext
268274
unf_ext (0.0.7.7)
275+
unf_ext (0.0.7.7-x64-mingw32)
269276
unicode-display_width (1.7.0)
277+
wdm (0.1.1)
270278
zeitwerk (2.4.2)
271279

272280
PLATFORMS
273281
ruby
282+
x64-mingw32
274283

275284
DEPENDENCIES
276285
github-pages
277286
jekyll-feed (~> 0.12)
287+
jekyll-redirect-from
278288
jekyll-remote-theme
279289
tzinfo (~> 1.2)
280290
tzinfo-data

about.md.draft

Lines changed: 0 additions & 10 deletions
This file was deleted.

quicktips/console-shortcuts.md renamed to features/console-shortcuts.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
---
22
layout: default
33
title: Console Shortcuts
4-
parent: Quicktips
4+
parent: Features
5+
nav_order: 50
56
has_children: false
6-
permalink: /quicktips/console-shortcuts
7+
permalink: /features/console-shortcuts
8+
redirect_from:
9+
- /quicktips/console-shortcuts
710
description: >-
811
Keyboard shortcuts are available for those who prefer shortcuts.
912
---
@@ -19,7 +22,7 @@ Issue a `HELP` command in the console to get a list of all available commands.
1922

2023
You can start typing a command and then complete it with the Tab key. If there are several possibilities, a list of choices will be displayed.
2124

22-
![](../assets/img/quicktips/console-shortcuts/tab_complete.gif)
25+
![](/assets/img/quicktips/console-shortcuts/tab_complete.gif)
2326

2427
## Scroll through commands
2528

quicktips/hide-gcode_macros-by-default.md renamed to features/hide-gcode_macros-by-default.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
---
22
layout: default
33
title: Hide macros, outputs or fans
4-
parent: Quicktips
4+
parent: Features
5+
nav_order: 50
56
has_children: false
6-
permalink: /quicktips/hide-gcode_macros
7+
permalink: /features/hide-gcode_macros
8+
redirect_from:
9+
- /quicktips/hide-gcode_macros
710
description: >-
811
You can show and hide G-Code macros in the interface settings
912
---
@@ -27,7 +30,7 @@ gcode:
2730
2831
`MY_AWESOME_GCODE` appears in your interface settings, `_MY_HELPER_CODE` does not.
2932

30-
![](../assets/img/quicktips/hide-gcode_macros/my_awesome_macro.png)
33+
![](/assets/img/quicktips/hide-gcode_macros/my_awesome_macro.png)
3134

3235
This also works for other configuration sections including **fans and outputs.**
3336
{: .info}

quicktips/history.md renamed to features/history.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
---
22
layout: default
33
title: Print History and Statistics
4-
parent: Quicktips
4+
parent: Features
5+
nav_order: 50
56
has_children: false
6-
permalink: /quicktips/history
7+
permalink: /features/history
8+
redirect_from:
9+
- /quicktips/history
710
description: >-
811
You can view your print history and statistics in the History section of Mainsail.
912

features/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
layout: default
3+
title: Features
4+
nav_order: 9
5+
has_children: true
6+
permalink: /features
7+
description: >-
8+
Mainsail offers a lot of great features that we would like to highlight here.
9+
---
10+
11+
# {{ page.title }}
12+
{{ page.description }}
13+
{: .fs-5 }

quicktips/presets.md renamed to features/presets.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
---
22
layout: default
33
title: Presets
4-
parent: Quicktips
4+
parent: Features
5+
nav_order: 50
56
has_children: false
6-
permalink: /quicktips/presets
7+
permalink: /features/presets
8+
redirect_from:
9+
- /quicktips/presets
710
description: >-
811
Mainsail supports so-called presets. They are often used for preheat & cooldown, but also execute normal gcode.
912
---
@@ -18,7 +21,7 @@ In Mainsails interface settings you will find a section called "Preheat Presets"
1821

1922
Enter a name for your preset, such as filament, color or other text and the temperature you wish to set the preset at. You can disable individual heaters and even specify a custom gcode for the preheat phase. The G-Code will be executed after the selected temperatures are set.
2023

21-
![](../assets/img/quicktips/presets/preheat.png)
24+
![](/assets/img/quicktips/presets/preheat.png)
2225

2326
### Further Examples
2427

@@ -27,4 +30,4 @@ You can add custom G-Code to make it easier to switch between different Z-Offset
2730

2831
To configure the G-Code enter `SET_GCODE_OFFSET Z=0.2`, and change `0.2` to the offset you need.
2932

30-
![](../assets/img/quicktips/presets/gcodeoffset.png)
33+
![](/assets/img/quicktips/presets/gcodeoffset.png)

themes/backgrounds.md renamed to features/themes/backgrounds.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,11 @@
22
layout: default
33
title: Backgrounds
44
parent: Theming
5+
grand_parent: Features
56
nav_order: 10
6-
permalink: /theming/backgrounds
7+
permalink: /features/theming/backgrounds
8+
redirect_from:
9+
- /theming/backgrounds
710
description: >-
811
Place some background images to give Mainsail its own look with ease.
912
---
@@ -14,11 +17,11 @@ description: >-
1417
There are two background images that can be used in Mainsail. The first is in the sidebar and the second is in the main section.
1518

1619

17-
![screenshot](../assets/img/customizing/sidebar-main.jpg){:width="50%"}
20+
![screenshot](/assets/img/customizing/sidebar-main.jpg){:width="50%"}
1821

1922
You can upload a new background image using the file manager located in `Settings > Machine`.
2023

21-
<!-- ![screenshot](../assets/img/customizing/screenshot-sidebar-background.png) -->
24+
<!-- ![screenshot](/assets/img/customizing/screenshot-sidebar-background.png) -->
2225

2326
## Sidebar background image
2427
Load the background image into your .theme folder and name it `sidebar-background.<extension>`.

themes/custom-css.md renamed to features/themes/custom-css.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,21 @@
22
layout: default
33
title: Custom CSS
44
parent: Theming
5+
grand_parent: Features
56
nav_order: 30
6-
permalink: /theming/custom-css
7+
permalink: /features/theming/custom-css
8+
redirect_from:
9+
- /theming/custom-css
710
---
811

912
# Custom CSS
1013

1114
The `custom.css` file allows you to customize the appearance of Mainsail
1215
without the need of rebuilding it. Place a file named `custom.css` in the `.theme` folder of your Mainsail installation and define your custom **C**ascading **S**tyle **S**heets (CSS) rules inside the file.
1316

14-
![file-screenshot](../assets/img/customizing/screenshot-custom-css.png "custom.css file")
17+
![file-screenshot](/assets/img/customizing/screenshot-custom-css.png "custom.css file")
1518

16-
![example result](../assets/img/customizing/screenshot-custom-css-example-result.png "custom.css result")
19+
![example result](/assets/img/customizing/screenshot-custom-css-example-result.png "custom.css result")
1720

1821

1922
## Customizing the CSS
@@ -25,23 +28,23 @@ You need to be familiar with the CSS syntax to customize Mainsail. There are ma
2528

2629
You will need to use your browser's built in developer tools to find the element you want to customize. You can do this by clicking the "Developer Tools" button in the browser's toolbar or by right clicking on the page and choosing `Inspect Element` or press `F12`.
2730

28-
![open dev-tools](../assets/img/customizing/screenshot-custom-css-inspect.png "open dev-tools")
31+
![open dev-tools](/assets/img/customizing/screenshot-custom-css-inspect.png "open dev-tools")
2932

3033
1. Activate the developer tools and inspector
3134
2. Select the desired element
3235
3. Find the selector
3336
4. Use the style editor to customize the element. Play around to find the style you like!
3437

35-
![find element](../assets/img/customizing/screenshot-custom-css-find-element.png "find the right element")
38+
![find element](/assets/img/customizing/screenshot-custom-css-find-element.png "find the right element")
3639

37-
![fiddle](../assets/img/customizing/screenshot-custom-css-fiddle.png "fiddle")
40+
![fiddle](/assets/img/customizing/screenshot-custom-css-fiddle.png "fiddle")
3841

3942
When you have achieved your desired appearance, copy the full "section", including the selector and curly braces.
4043

41-
![fiddle 2](../assets/img/customizing/screenshot-custom-css-fiddle-2.png "fiddle 2")
44+
![fiddle 2](/assets/img/customizing/screenshot-custom-css-fiddle-2.png "fiddle 2")
4245

4346
Next copy it inside the "custom.css" file (you can keep everything or only what you have added)
4447

45-
![example](../assets/img/customizing/screenshot-custom-css-example.png "custom.css example")
48+
![example](/assets/img/customizing/screenshot-custom-css-example.png "custom.css example")
4649

4750
NOTE: After saving, your browser may need a uncached reload to show the change. Visit [Wikipedia to learn how.](https://en.wikipedia.org/wiki/Wikipedia:Bypass_your_cache#Bypassing_cache)

themes/icons.md renamed to features/themes/icons.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,11 @@
22
layout: default
33
title: Logos and Icons
44
parent: Theming
5+
grand_parent: Features
56
nav_order: 20
6-
permalink: /theming/favicons
7+
permalink: /features/theming/icons
8+
redirect_from:
9+
- /theming/favicons
710
description: >-
811
Replace the default logos and icons with your own.
912
---
@@ -16,13 +19,13 @@ You can use the built in file manager in `Settings > Machine` to upload your own
1619
## Sidebar logo
1720
Upload a logo into your .theme folder and name it `sidebar-logo.<extension>`, where extension is one of the valid file types below.
1821

19-
For more information on creating and uploading to your `.theme` folder, please refer to the [Customizing your theme](/theming/prepare) chapter.
22+
For more information on creating and uploading to your `.theme` folder, please refer to the [Customizing your theme](/features/theming/prepare) chapter.
2023

2124
| Filename | sidebar-logo |
2225
| Valid file extensions | .svg, .jpg, .png and .gif |
2326
| Recommended image size | XxY px |
2427

25-
![screenshot](../assets/img/customizing/screenshot-sidebar-logo.png)
28+
![screenshot](/assets/img/customizing/screenshot-sidebar-logo.png)
2629

2730
## Favicons
2831
Upload favicons into your .theme folder and name them `favicon-32x32.png` *(required)* and `favicon-16x16.png` *(optional)*.
@@ -35,6 +38,4 @@ Upload favicons into your .theme folder and name them `favicon-32x32.png` *(requ
3538
A browser refresh may be necessary (CTRL+SHIFT+F5 on windows or CMD++SHIFT+R on macOS) to reload without the browser cache.
3639
{: .info}
3740

38-
![screenshot](../assets/img/customizing/screenshot-favicons.png)
39-
40-
41+
![screenshot](/assets/img/customizing/screenshot-favicons.png)

0 commit comments

Comments
 (0)