Reworked the WLED ESP Flasher page and added mkdocs content tab support - #356
Merged
Conversation
The page was orphaned: absent from the nav, and its front matter
title duplicated the ESP GUI page ("Installation using ESP GUI"),
even though it documents a different tool (the WLED ESP Flasher
from the WLED-wemos-shield project). Install Binary actively
recommends it for ESP32, so it deserves a sidebar entry.
- retitle to "Install using WLED ESP Flasher" and register it
under Basics > Installation
- replace the browse-the-GitHub-folder download step with
Windows/macOS content tabs linking the zips directly (both
verified: 15MB and 32MB application/zip responses)
- enable pymdownx.tabbed (alternate style), Material's content
tabs; this is the first page to use them
Contributor
WalkthroughThe installation documentation now uses the WLED ESP Flasher title, provides platform-specific download instructions, enables tabbed Markdown support, and adds the page to the installation navigation. ChangesWLED ESP Flasher documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The WLED ESP Flasher page was orphaned: absent from the nav, and its front-matter title duplicated the ESP GUI page ("Installation using ESP GUI") even though it documents a different tool (the flasher from the WLED-wemos-shield project). The Install Binary page actively recommends it for ESP32, so it deserves a sidebar entry.
pymdownx.tabbed(alternate style), Material's content tabs. This is the first page to use them; other OS- or board-split pages like Install Binary could adopt them later.Demo:
Update: added a slugify function to the tabbed config so tab anchors derive from the labels (
#windows/#macos) instead of the auto-generated#__tabbed_1_1ids, which makes shared links to a specific tab readable and stable.Summary by CodeRabbit