docs: add a documentation website under docs/ - #48
Merged
Conversation
The README ran to three hundred lines covering five platforms. Those move to an atelier website under docs/, which links the references itself: the site turns in-text rewriting on, unlike the others in the family, which run the widget alone. This repository publishes one of the website's own dependencies, so the committed copy under docs/_extensions/mcanouil/ is dropped and the site resolves the filter from the copy sync-extension.sh takes from the repository root, running the version being released. The widget in the sidebar is the extension documenting itself. README.md becomes a landing page pointing at the website.
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.
…bsite # Conflicts: # CHANGELOG.md
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.
The platforms table lumped all five together and said nothing about how they differ. Record each base URL, the GitLab !N merge request form, the GitHub GH-N form, and the commit and mention forms with their 7 to 40 character bound. Document the widget's built-in entries with their defaults and platform coverage, style-navbar-tools, and that Bitbucket exposes no star count.
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 was referenced Aug 1, 2026
This was referenced Aug 1, 2026
This was referenced Aug 1, 2026
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-gitlink/.The README ran to some three hundred lines covering five platforms. The site links the references with the filter itself: unlike every other site in this family, which runs the widget alone with
enabled: false, this one turns in-text rewriting on, so#1,owner/repo#1,@mcanouil, and a bare platform URL are all resolved on the page. The widget in the sidebar is the same extension documenting itself.This repository publishes one of the website scaffold's own dependencies, so it is set up the self-hosting way: the committed copy under
docs/_extensions/mcanouil/gitlink/is dropped, and the filter resolves from the copysync-extension.shtakes from the repository root. The site therefore runs the version being released.README.mdbecomes a landing page pointing at the site.