docs: add a documentation website under docs/ - #41
Open
mcanouil wants to merge 4 commits into
Open
Conversation
Every code block on the site is framed by the extension, so the pages
are their own demonstration: the three styles, both folding states, the
highlighted-line chip, and a block with the chrome turned off.
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. The site therefore runs the version being released.
The reference records that the filter claims code blocks at pre-quarto,
which is why typst-render never sees its own {typst} blocks when both
run, and why language-cell-decorator decorates the same blocks twice.
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.
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-code-window/.Every code block on the site is framed by this extension, so the pages demonstrate themselves. The examples page adds the parts the default does not show: all three window styles side by side, both folding states, the highlighted-line chip, and a block with the chrome turned off.
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/code-window/is dropped, and the filter resolves from the copysync-extension.shtakes from the repository root. The site therefore runs the version being released rather than a pinned one.reference.qmdrecords an interaction found while documenting the rest of the family: this filter claims code blocks atpre-quarto, which is whytypst-rendernever sees its own```{typst}blocks when both run, and whylanguage-cell-decoratordecorates the same blocks a second time.README.mdbecomes a landing page pointing at the site.