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.
This commit is contained in:
lixxbox 2022-01-29 11:05:04 +01:00 committed by GitHub
parent 44637266bf
commit 4f9581f3a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
22 changed files with 119 additions and 203 deletions

View File

@ -25,6 +25,7 @@ GEM
ethon (0.14.0)
ffi (>= 1.15.0)
eventmachine (1.2.7)
eventmachine (1.2.7-x64-mingw32)
execjs (2.8.1)
faraday (1.7.0)
faraday-em_http (~> 1.0)
@ -46,6 +47,7 @@ GEM
faraday-patron (1.0.0)
faraday-rack (1.0.0)
ffi (1.15.3)
ffi (1.15.3-x64-mingw32)
forwardable-extended (2.6.0)
gemoji (3.0.1)
github-pages (218)
@ -229,6 +231,8 @@ GEM
nokogiri (1.12.5)
mini_portile2 (~> 2.6.1)
racc (~> 1.4)
nokogiri (1.12.5-x64-mingw32)
racc (~> 1.4)
octokit (4.21.0)
faraday (>= 0.9)
sawyer (~> 0.8.0, >= 0.5.3)
@ -263,18 +267,24 @@ GEM
ethon (>= 0.9.0)
tzinfo (1.2.9)
thread_safe (~> 0.1)
tzinfo-data (1.2021.5)
tzinfo (>= 1.0.0)
unf (0.1.4)
unf_ext
unf_ext (0.0.7.7)
unf_ext (0.0.7.7-x64-mingw32)
unicode-display_width (1.7.0)
wdm (0.1.1)
zeitwerk (2.4.2)
PLATFORMS
ruby
x64-mingw32
DEPENDENCIES
github-pages
jekyll-feed (~> 0.12)
jekyll-redirect-from
jekyll-remote-theme
tzinfo (~> 1.2)
tzinfo-data

View File

@ -1,10 +0,0 @@
---
layout: default
title: About
nav_order: 100
has_children: false
permalink: /about
---
# About Mainsail
trollolol

View File

@ -1,9 +1,12 @@
---
layout: default
title: Console Shortcuts
parent: Quicktips
parent: Features
nav_order: 50
has_children: false
permalink: /quicktips/console-shortcuts
permalink: /features/console-shortcuts
redirect_from:
- /quicktips/console-shortcuts
description: >-
Keyboard shortcuts are available for those who prefer shortcuts.
---
@ -19,7 +22,7 @@ Issue a `HELP` command in the console to get a list of all available commands.
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.
![](../assets/img/quicktips/console-shortcuts/tab_complete.gif)
![](/assets/img/quicktips/console-shortcuts/tab_complete.gif)
## Scroll through commands

View File

@ -1,9 +1,12 @@
---
layout: default
title: Hide macros, outputs or fans
parent: Quicktips
parent: Features
nav_order: 50
has_children: false
permalink: /quicktips/hide-gcode_macros
permalink: /features/hide-gcode_macros
redirect_from:
- /quicktips/hide-gcode_macros
description: >-
You can show and hide G-Code macros in the interface settings
---
@ -27,7 +30,7 @@ gcode:
`MY_AWESOME_GCODE` appears in your interface settings, `_MY_HELPER_CODE` does not.
![](../assets/img/quicktips/hide-gcode_macros/my_awesome_macro.png)
![](/assets/img/quicktips/hide-gcode_macros/my_awesome_macro.png)
This also works for other configuration sections including **fans and outputs.**
{: .info}

View File

@ -1,9 +1,12 @@
---
layout: default
title: Print History and Statistics
parent: Quicktips
parent: Features
nav_order: 50
has_children: false
permalink: /quicktips/history
permalink: /features/history
redirect_from:
- /quicktips/history
description: >-
You can view your print history and statistics in the History section of Mainsail.

13
docs/features/index.md Normal file
View File

@ -0,0 +1,13 @@
---
layout: default
title: Features
nav_order: 9
has_children: true
permalink: /features
description: >-
Mainsail offers a lot of great features that we would like to highlight here.
---
# {{ page.title }}
{{ page.description }}
{: .fs-5 }

View File

@ -1,9 +1,12 @@
---
layout: default
title: Presets
parent: Quicktips
parent: Features
nav_order: 50
has_children: false
permalink: /quicktips/presets
permalink: /features/presets
redirect_from:
- /quicktips/presets
description: >-
Mainsail supports so-called presets. They are often used for preheat & cooldown, but also execute normal gcode.
---
@ -18,7 +21,7 @@ In Mainsails interface settings you will find a section called "Preheat Presets"
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.
![](../assets/img/quicktips/presets/preheat.png)
![](/assets/img/quicktips/presets/preheat.png)
### Further Examples
@ -27,4 +30,4 @@ You can add custom G-Code to make it easier to switch between different Z-Offset
To configure the G-Code enter `SET_GCODE_OFFSET Z=0.2`, and change `0.2` to the offset you need.
![](../assets/img/quicktips/presets/gcodeoffset.png)
![](/assets/img/quicktips/presets/gcodeoffset.png)

View File

@ -2,8 +2,11 @@
layout: default
title: Backgrounds
parent: Theming
grand_parent: Features
nav_order: 10
permalink: /theming/backgrounds
permalink: /features/theming/backgrounds
redirect_from:
- /theming/backgrounds
description: >-
Place some background images to give Mainsail its own look with ease.
---
@ -14,11 +17,11 @@ description: >-
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.
![screenshot](../assets/img/customizing/sidebar-main.jpg){:width="50%"}
![screenshot](/assets/img/customizing/sidebar-main.jpg){:width="50%"}
You can upload a new background image using the file manager located in `Settings > Machine`.
<!-- ![screenshot](../assets/img/customizing/screenshot-sidebar-background.png) -->
<!-- ![screenshot](/assets/img/customizing/screenshot-sidebar-background.png) -->
## Sidebar background image
Load the background image into your .theme folder and name it `sidebar-background.<extension>`.

View File

@ -2,8 +2,11 @@
layout: default
title: Custom CSS
parent: Theming
grand_parent: Features
nav_order: 30
permalink: /theming/custom-css
permalink: /features/theming/custom-css
redirect_from:
- /theming/custom-css
---
# Custom CSS
@ -11,9 +14,9 @@ permalink: /theming/custom-css
The `custom.css` file allows you to customize the appearance of Mainsail
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.
![file-screenshot](../assets/img/customizing/screenshot-custom-css.png "custom.css file")
![file-screenshot](/assets/img/customizing/screenshot-custom-css.png "custom.css file")
![example result](../assets/img/customizing/screenshot-custom-css-example-result.png "custom.css result")
![example result](/assets/img/customizing/screenshot-custom-css-example-result.png "custom.css result")
## Customizing the CSS
@ -25,23 +28,23 @@ You need to be familiar with the CSS syntax to customize Mainsail. There are ma
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`.
![open dev-tools](../assets/img/customizing/screenshot-custom-css-inspect.png "open dev-tools")
![open dev-tools](/assets/img/customizing/screenshot-custom-css-inspect.png "open dev-tools")
1. Activate the developer tools and inspector
2. Select the desired element
3. Find the selector
4. Use the style editor to customize the element. Play around to find the style you like!
![find element](../assets/img/customizing/screenshot-custom-css-find-element.png "find the right element")
![find element](/assets/img/customizing/screenshot-custom-css-find-element.png "find the right element")
![fiddle](../assets/img/customizing/screenshot-custom-css-fiddle.png "fiddle")
![fiddle](/assets/img/customizing/screenshot-custom-css-fiddle.png "fiddle")
When you have achieved your desired appearance, copy the full "section", including the selector and curly braces.
![fiddle 2](../assets/img/customizing/screenshot-custom-css-fiddle-2.png "fiddle 2")
![fiddle 2](/assets/img/customizing/screenshot-custom-css-fiddle-2.png "fiddle 2")
Next copy it inside the "custom.css" file (you can keep everything or only what you have added)
![example](../assets/img/customizing/screenshot-custom-css-example.png "custom.css example")
![example](/assets/img/customizing/screenshot-custom-css-example.png "custom.css example")
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)

View File

@ -2,8 +2,11 @@
layout: default
title: Logos and Icons
parent: Theming
grand_parent: Features
nav_order: 20
permalink: /theming/favicons
permalink: /features/theming/icons
redirect_from:
- /theming/favicons
description: >-
Replace the default logos and icons with your own.
---
@ -16,13 +19,13 @@ You can use the built in file manager in `Settings > Machine` to upload your own
## Sidebar logo
Upload a logo into your .theme folder and name it `sidebar-logo.<extension>`, where extension is one of the valid file types below.
For more information on creating and uploading to your `.theme` folder, please refer to the [Customizing your theme](/theming/prepare) chapter.
For more information on creating and uploading to your `.theme` folder, please refer to the [Customizing your theme](/features/theming/prepare) chapter.
| Filename | sidebar-logo |
| Valid file extensions | .svg, .jpg, .png and .gif |
| Recommended image size | XxY px |
![screenshot](../assets/img/customizing/screenshot-sidebar-logo.png)
![screenshot](/assets/img/customizing/screenshot-sidebar-logo.png)
## Favicons
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
A browser refresh may be necessary (CTRL+SHIFT+F5 on windows or CMD++SHIFT+R on macOS) to reload without the browser cache.
{: .info}
![screenshot](../assets/img/customizing/screenshot-favicons.png)
![screenshot](/assets/img/customizing/screenshot-favicons.png)

View File

@ -1,9 +1,12 @@
---
layout: default
title: Theming
nav_order: 6
parent: Features
nav_order: 100
has_children: true
permalink: /theming
permalink: /features/theming
redirect_from:
- /theming
description: >-
Personalize Mainsail according to your preferences. Here you will find instructions for custom background images, logos, icons & more.
---

View File

@ -2,8 +2,11 @@
layout: default
title: Prepare
parent: Theming
grand_parent: Features
nav_order: 1
permalink: /theming/prepare
permalink: /features/theming/prepare
redirect_from:
- /theming/prepare
description: >-
Create a basic folder structure to build your own theme.
---
@ -18,7 +21,7 @@ You can use Mainsail's built-in file manager (`Settings > Machine`) to create th
The dot in the folder name means that it is a hidden folder. You will need to activate "Show Hidden Files" in Mainsail's file manager.
{: .info}
![screenshot](../assets/img/customizing/screenshot-display-hidden-files.png)
![screenshot](/assets/img/customizing/screenshot-display-hidden-files.png)
## Directory structure
The below directory and file structure provides an overview of files you could include. All listed files in the `.theme` folder are optional and will only be loaded if they are provided.
@ -29,10 +32,10 @@ The below directory and file structure provides an overview of files you could i
|-- klipper_config
| |-- .theme
| | |-- sidebar-logo.svg|jpg|png|gif
| | |-- sidebar-background.jpg|png|gif
| | |-- main-background.jpg|png|gif
| | |-- sidebar-background.svg|jpg|png|gif
| | |-- main-background.svg|jpg|png|gif
| | |-- favicon-16x16.png
| | |-- favicon-32x32.png
| | |-- custom.css
| | |-- ...
```
```

View File

@ -5,7 +5,9 @@ grand_parent: Theming
parent: Community Themes
nav_exclude: true
nav_order: 150
permalink: /theming/themes/submit
permalink: /features/theming/themes/submit
redirect_from:
- /theming/themes/submit
description: >-
Submit a theme!
---

View File

@ -2,9 +2,12 @@
layout: themes
title: Community Themes
parent: Theming
grand_parent: Features
nav_order: 100
has_children: false
permalink: /theming/themes
permalink: /features/theming/themes
redirect_from:
- /theming/themes
description: >-
A collection of community themes for Mainsail.
---
@ -43,6 +46,4 @@ Go to `[Advanced] > [Theme installer]`, enter the desired theme <span class="key
<script>set_image('img{{forloop.index}}', 'https://raw.githubusercontent.com/{{ theme.author }}/{{ theme.repo }}/master/screenshot', 200000);</script>
<noscript><img width="50%" id="img{{forloop.index}}" class="screenshot" src="https://raw.githubusercontent.com/{{ theme.author }}/{{ theme.repo }}/master/screenshot.png" loading="lazy" alt="no screenshot found"/></noscript>
{% endfor %}
{% endfor %}

View File

@ -1,8 +1,12 @@
---
layout: default
title: Thumbnails
parent: Quicktips
permalink: /quicktips/thumbnails
parent: Features
nav_order: 10
has_children: false
permalink: /features/thumbnails
redirect_from:
- /quicktips/thumbnails
description: >-
Mainsail can display thumbnails in the file browser and as previews in the print status.
---
@ -11,7 +15,7 @@ description: >-
{: .no_toc}
{{ page.description }}
![preview](../assets/img/additional/large-preview.png)
![preview](/assets/img/additional/large-preview.png)
<details open markdown="block">
<summary>
@ -27,7 +31,7 @@ description: >-
In "Expert" mode PrusaSlicer has an option in the "Printer Settings" tab to activate previews.
Under `General / Firmware`, enter `32x32,400x300` as "G-code thumbnails".
![PrusaSlicer](../assets/img/additional/PrusaSlicer2.3.0-thumbnails.png)
![PrusaSlicer](/assets/img/additional/PrusaSlicer2.3.0-thumbnails.png)
<div class="youtube-container">
<iframe type="text/html" src="https://www.youtube.com/embed/4nFqfq8kikU" frameborder="0"></iframe>

View File

@ -1,9 +1,12 @@
---
layout: default
title: Update Manager
parent: Quicktips
parent: Features
nav_order: 20
has_children: false
permalink: /quicktips/update-manager
permalink: /features/update-manager
redirect_from:
- /quicktips/update-manager
description: >-
Perform updates of Mainsail, Klipper, Moonraker and your system from within Mainsail.
---
@ -26,7 +29,7 @@ path: ~/mainsail
Restart the Moonraker service and the Update Manager will appear in Mainsail's machine settings.
![](../assets/img/quicktips/update-manager/update-manager.png)
![](/assets/img/quicktips/update-manager/update-manager.png)
You can find further information on this topic by visiting the [Moonraker documentation](https://github.com/Arksine/moonraker/blob/master/docs/configuration.md#update_manager){:target="_blank"}.

View File

@ -1,11 +1,14 @@
---
layout: default
title: Multicam
parent: Quicktips
title: Webcams
parent: Features
nav_order: 50
has_children: false
permalink: /quicktips/multicam
permalink: /features/webcams
redirect_from:
- /quicktips/multicam
description: >-
How to setup multi Webcams with mainsailOS.
How to setup multiple Webcams with mainsailOS.
---
# {{ page.title }}

View File

@ -1,123 +0,0 @@
---
layout: default
title: Necessary Configuration
nav_exclude: true
has_children: false
permalink: /necessary-configuration
---
Mainsail requires a minimum configuration to function properly. It should give you a warning at startup if the required parts are not found in your configuration.
# Required configuration
## virtual_sdcard
This allows gcode file uploads.
```yaml
[virtual_sdcard]
path: ~/gcode_files
```
## display_status
This is required for messages in your status panel, if you don't have a `[display]` in your configuration.
```yaml
[display_status]
```
## pause / resume / cancel
This enables pause / resume in mainsail.
```yaml
[pause_resume]
```
# Macros
## for pause / resume / cancel functionality
These should be modified to your own needs.
{% raw %}
```yaml
[gcode_macro PAUSE]
description: Pause the actual running print
rename_existing: PAUSE_BASE
gcode:
##### set defaults #####
{% set x = params.X|default(230) %} #edit to your park position
{% set y = params.Y|default(230) %} #edit to your park position
{% set z = params.Z|default(10)|float %} #edit to your park position
{% set e = params.E|default(1) %} #edit to your retract length
##### calculate save lift position #####
{% set max_z = printer.toolhead.axis_maximum.z|float %}
{% set act_z = printer.toolhead.position.z|float %}
{% set lift_z = z|abs %}
{% if act_z < (max_z - lift_z) %}
{% set z_safe = lift_z %}
{% else %}
{% set z_safe = max_z - act_z %}
{% endif %}
##### end of definitions #####
PAUSE_BASE
G91
{% if printer.extruder.can_extrude|lower == 'true' %}
G1 E-{e} F2100
{% else %}
{action_respond_info("Extruder not hot enough")}
{% endif %}
{% if "xyz" in printer.toolhead.homed_axes %}
G1 Z{z_safe}
G90
G1 X{x} Y{y} F6000
{% else %}
{action_respond_info("Printer not homed")}
{% endif %}
```
```yaml
[gcode_macro RESUME]
description: Resume the actual running print
rename_existing: RESUME_BASE
gcode:
##### set defaults #####
{% set e = params.E|default(1) %} #edit to your retract length
#### get VELOCITY parameter if specified ####
{% if 'VELOCITY' in params|upper %}
{% set get_params = ('VELOCITY=' + params.VELOCITY) %}
{%else %}
{% set get_params = "" %}
{% endif %}
##### end of definitions #####
G91
{% if printer.extruder.can_extrude|lower == 'true' %}
G1 E{e} F2100
{% else %}
{action_respond_info("Extruder not hot enough")}
{% endif %}
RESUME_BASE {get_params}
```
```yaml
[gcode_macro CANCEL_PRINT]
description: Cancel the actual running print
rename_existing: CANCEL_PRINT_BASE
gcode:
TURN_OFF_HEATERS
CANCEL_PRINT_BASE
```
{% endraw %}
# Optional
## customize klipper default commands
for example, if you want to adjust the `BED_MESH_CALIBRATE` command, which you can run from "heightmap > calibrate".
{% raw %}
```yaml
[gcode_macro BED_MESH_CALIBRATE]
rename_existing: BASE_BED_MESH_CALIBRATE
gcode:
#before the original gcode
BED_MESH_CLEAR
QUAD_GANTRY_LEVEL
G1 X125 Y125 Z5 F6000
#the original gcode
BASE_BED_MESH_CALIBRATE
#after the original gcode
```
{% endraw %}

View File

@ -5,8 +5,9 @@ nav_order: 10
has_children: true
permalink: /quicktips
description: >-
Quick tips for Mainsail users.
A collection of features that are not directly built into Mainsail, but will increase your workflow.
---
# {{ page.title }}
{{ page.description }}
{{ page.description }}
{: .fs-5 }

View File

@ -2,6 +2,7 @@
layout: default
title: Remote Access
parent: Quicktips
nav_order: 20
permalink: /quicktips/remote-access
description: >-
A guide to safe remote access.
@ -33,7 +34,7 @@ What <b>not to do</b>:
<ul>
<li>Please do not open ports of Mainsail/Moonraker in your router to the rest of the world. There are plenty of reports of Octoprint installations being freely accessible on the Internet, with just as many reasons why this is not a good idea.</li>
</ul>
<a href="https://isc.sans.edu/forums/diary/3D+Printers+in+The+Wild+What+Can+Go+Wrong/24044/" target="_blank">https://isc.sans.edu/forums/diary/3D+Printers+in+The+Wild+What+Can+Go+Wrong/24044/</a>
<a href="https://isc.sans.edu/forums/diary/3D+Printers+in+The+Wild+What+Can+Go+Wrong/24044/" target="_blank">3D Printers in The Wild, What Can Go Wrong</a>
</div>
<div class="warning">

View File

@ -2,6 +2,7 @@
layout: default
title: Slicer Upload
parent: Quicktips
nav_order: 10
permalink: /quicktips/slicer-upload
description: >-
You can upload your sliced G-Code from within your slicer and have it start printing.

View File

@ -1,15 +0,0 @@
---
layout: default
title: Remote Mode
nav_order: 4
nav_exclude: true
has_children: false
permalink: /remotemode
description: >-
description in progress
---
# {{ page.title }}
{{ page.description }}
The description will follow soon.