From 0ce5dc5f19e5fa0ade5a4e32cd0ba83381147275 Mon Sep 17 00:00:00 2001 From: Maxim Devaev Date: Tue, 25 Mar 2025 03:01:42 +0200 Subject: [PATCH] update --- .github/workflows/ci.yml | 2 +- docs/_assets/user.css | 4 ++++ docs/_basic_troubleshooting.md | 6 ++++++ docs/_diy_first_launch.md | 6 ++++++ docs/_diy_parts_atx.md | 6 ++++++ docs/_diy_setup_video_csi.md | 6 ++++++ docs/_diy_setup_video_usb.md | 6 ++++++ docs/_diy_wiring_atx.md | 6 ++++++ docs/_multiport_usb.md | 6 ++++++ docs/_passwd.md | 6 ++++++ docs/_pico_hid_flashing.md | 6 ++++++ docs/_pico_hid_parts.md | 6 ++++++ docs/_update_os.md | 6 ++++++ docs/_usb_limits.md | 6 ++++++ mkdocs.yml | 20 +++++++++++++++++--- 15 files changed, 94 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c11d37f..3f58d84 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -13,5 +13,5 @@ jobs: with: python-version: 3.x # We're using the own fork of markdown-include because of indention - - run: pip install mkdocs-material mkdocs-video mkdocs-redirects markdown==3.3.7 git+https://github.com/pikvm/markdown-include + - run: pip install mkdocs-material mkdocs-video mkdocs-redirects mkdocs-glightbox git+https://github.com/pikvm/markdown-include - run: mkdocs gh-deploy --force diff --git a/docs/_assets/user.css b/docs/_assets/user.css index a62a589..34afe8f 100644 --- a/docs/_assets/user.css +++ b/docs/_assets/user.css @@ -30,6 +30,10 @@ li.md-nav__item--section > label.md-nav__link { position: unset; }*/ +.md-nav__toggle~.md-nav>.md-nav__list { + margin-left: 15px; +} + .md-sidebar.md-sidebar--secondary { padding-top: 10px; } diff --git a/docs/_basic_troubleshooting.md b/docs/_basic_troubleshooting.md index e959603..8bfaa2f 100644 --- a/docs/_basic_troubleshooting.md +++ b/docs/_basic_troubleshooting.md @@ -1,3 +1,9 @@ +--- +search: + exclude: true +--- + + * Ensure that you are using the right [OS image](flashing_os.md) for your platform by running the following command: `pacman -Q | grep kvmd-platform`. diff --git a/docs/_diy_first_launch.md b/docs/_diy_first_launch.md index cc4932b..104e86e 100644 --- a/docs/_diy_first_launch.md +++ b/docs/_diy_first_launch.md @@ -1,3 +1,9 @@ +--- +search: + exclude: true +--- + + 1. Double-check the correct assembly of the device, and make sure that you have connected all the necessary cables to the host: USB, HDMI and ATX. diff --git a/docs/_diy_parts_atx.md b/docs/_diy_parts_atx.md index 56d6bdd..3dea46b 100644 --- a/docs/_diy_parts_atx.md +++ b/docs/_diy_parts_atx.md @@ -1,3 +1,9 @@ +--- +search: + exclude: true +--- + + With this part, you will be able to remotely turn on, turn off and restart your computer! * *x4* MOSFET relays [OMRON G3VM-61A1](https://www.digikey.com/products/en?keywords=G3VM-61A1) diff --git a/docs/_diy_setup_video_csi.md b/docs/_diy_setup_video_csi.md index cff2fed..2757cf2 100644 --- a/docs/_diy_setup_video_csi.md +++ b/docs/_diy_setup_video_csi.md @@ -1,3 +1,9 @@ +--- +search: + exclude: true +--- + + Insert the flexible flat cable of the HDMI-CSI bridge into the narrow white connector on the Raspberry Pi (the closest one to big USB sockets). It is labeled `CAMERA`. To insert you need to open the connector first. On the Raspberry Pi side you can gently lift the black part up and a little bit sideways: diff --git a/docs/_diy_setup_video_usb.md b/docs/_diy_setup_video_usb.md index d56f184..bfa5e36 100644 --- a/docs/_diy_setup_video_usb.md +++ b/docs/_diy_setup_video_usb.md @@ -1,3 +1,9 @@ +--- +search: + exclude: true +--- + + Connect USB dongle to exactly this port. It is bound in the software so the OS does not confuse the video device with something else. | Raspberry Pi 2 and 3 | Raspberry Pi 4 | diff --git a/docs/_diy_wiring_atx.md b/docs/_diy_wiring_atx.md index 978aeb9..411fe5d 100644 --- a/docs/_diy_wiring_atx.md +++ b/docs/_diy_wiring_atx.md @@ -1,3 +1,9 @@ +--- +search: + exclude: true +--- + + To control the power, two display LEDs (power and HDD activity) and two buttons (power and reset) are provided on the front panel of the computer case. They are connected by wires to pins on the motherboard. diff --git a/docs/_multiport_usb.md b/docs/_multiport_usb.md index bbd837f..2995b04 100644 --- a/docs/_multiport_usb.md +++ b/docs/_multiport_usb.md @@ -1,3 +1,9 @@ +--- +search: + exclude: true +--- + + !!! info "PiKVM + Multiport Switches compatibility" Please note that this switch requires a USB port for control. The following devices can provide this: diff --git a/docs/_passwd.md b/docs/_passwd.md index 42f9f89..d6c3750 100644 --- a/docs/_passwd.md +++ b/docs/_passwd.md @@ -1,3 +1,9 @@ +--- +search: + exclude: true +--- + + ??? danger "✮ ✮ ✮ CHANGE THE PASSWORDS! ✮ ✮ ✮" PiKVM comes with the following default passwords: diff --git a/docs/_pico_hid_flashing.md b/docs/_pico_hid_flashing.md index 3cf11ac..ce84254 100644 --- a/docs/_pico_hid_flashing.md +++ b/docs/_pico_hid_flashing.md @@ -1,3 +1,9 @@ +--- +search: + exclude: true +--- + + To upload the firmware to Pico HID, you can use any computer with a USB port. 1. [Download](https://github.com/pikvm/kvmd/releases) the latest release of the firmware. The file is called `pico-hid.uf2`. diff --git a/docs/_pico_hid_parts.md b/docs/_pico_hid_parts.md index e081340..52a7dea 100644 --- a/docs/_pico_hid_parts.md +++ b/docs/_pico_hid_parts.md @@ -1,3 +1,9 @@ +--- +search: + exclude: true +--- + + * *x1* [Raspberry Pi Pico board](https://www.raspberrypi.com/products/raspberry-pi-pico/) with soldered pins. Pico 2 is not supported right now. * *x1* USB-A to Micro-USB cable. diff --git a/docs/_update_os.md b/docs/_update_os.md index 050805b..d74eb23 100644 --- a/docs/_update_os.md +++ b/docs/_update_os.md @@ -1,3 +1,9 @@ +--- +search: + exclude: true +--- + + ??? example "Updating PiKVM OS" To update, run following commands under the `root` user: diff --git a/docs/_usb_limits.md b/docs/_usb_limits.md index 0c0ab18..38dbc9b 100644 --- a/docs/_usb_limits.md +++ b/docs/_usb_limits.md @@ -1,3 +1,9 @@ +--- +search: + exclude: true +--- + + !!! info "USB limitations" Each emulated USB device consumes a limited hardware resource called **endpoints**. diff --git a/mkdocs.yml b/mkdocs.yml index d39dab5..2c0cc2b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,8 +20,9 @@ theme: logo: _assets/logo.png favicon: _assets/favicon.ico name: material - palette: - accent: pink +# palette: +# primary: black +# accent: black font: text: "arial, sans-serif" code: monospace @@ -29,7 +30,7 @@ theme: - navigation.indexes - navigation.sections - navigation.top - - navigation.tracking +# - navigation.tracking - navigation.expand - search.highlight - search.share @@ -46,6 +47,7 @@ markdown_extensions: - pymdownx.details - pymdownx.superfences - pymdownx.magiclink + - pymdownx.blocks.caption - toc: permalink: true - codehilite: @@ -65,6 +67,18 @@ plugins: "4g.md": "modem.md" "usb_dynamic.md": "usb.md" "webrtc.md": "video.md" + - glightbox: + touchNavigation: false + loop: false + slide_effect: slide + width: 95% + height: auto + zoomable: true + auto_caption: false + caption_position: bottom + background: white + shadow: true + manual: false nav: - "Device guides":