docs: add a documentation website under docs/ - #35
Merged
Conversation
The README carried the reference: every audio, volume, and keyboard option, described but never demonstrated. Those move to an atelier website under docs/, which renders a working button with the extension itself. Records two things the README did not. A page carries one working button: every shortcode emits a button with the same class and every script block wires the first one it finds, so a second button on the page gets no elevator. And the bundled arrival sound is registered with add_format_resource while a page renders, which is after Quarto has resolved the project resources, so on a clean checkout it never reaches the output; docs/_scripts/pre-render.sh copies it in beforehand and _quarto.yml names it as a resource. README.md becomes a landing page and example.qmd a short starting point to copy. The Pages workflow renders docs/ on pull requests and deploys it from the release tag; the Quarto Extensions Updates workflow keeps the site's own dependencies current.
The generated copy of this repository's own extension sat directly under docs/_extensions/, with no owner, where it read as just another installed extension. It now goes to docs/_extensions/local/<name>/, so the path says where it came from and keeps it clear of the committed dependencies. Quarto resolves an extension under any owner directory, so nothing referencing it changes.
Picked up from the shared scaffold.
Picked up from the shared scaffold.
1.9.1 keeps the widget's menu inside a docked sidebar, which is what the three rules in assets/theme.scss did here. Those rules go with it.
pre-render.sh copies the bundled arrival sound into docs/ so the `resources` entry can find it, and post-render.sh removes it again, but nothing ignored it in between. Point the _quarto.yml comment at the scripts that do the work, and fill in the author fields the scaffold left as placeholders.
The Quarto project root is docs/, so the edit and issue links were built one level up from the page they belong to and did not resolve.
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
1 participant
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.
Moves the reference documentation out of
README.mdand into a Quarto website underdocs/, built on theatelierproject type and published to https://m.canouil.dev/quarto-elevator/.The examples page renders a working button with the extension itself, so the ride can be tried rather than described.
reference.qmdrecords a limitation the README did not: a page carries one working button. Every shortcode emits a button with theelevator-buttonclass and every script block wires the first one it finds, so a second shortcode on a page gives the first button two elevators and the second none.It also fixes a broken sound. The extension registers its bundled
ding.mp3withadd_format_resource, which writes it into the project directory while a page renders, after Quarto has already resolved the project resources. On a clean checkout the file never reaches the output and the arrival sound 404s.docs/_scripts/pre-render.shnow copies it in before the render anddocs/_quarto.ymlnames it underproject.resources;post-render.shremoves the copy afterwards.README.mdbecomes a landing page pointing at the site, andexample.qmda short standalone starting point to copy..github/workflows/pages.ymlrendersdocs/on pull requests as a check and deploys it from the release tag..github/workflows/quarto-extensions-updates.ymlkeeps the site's own dependencies current.