Move tutorial to Jekyll website #613
Merged
Conversation
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
matt-graham
added
the
website
Collaborator
Author
|
Tagging you for review @samcunliffe as you did some previous investigation on related issue #577 but appreciate you've just reviewed two other PRs from me so no worries if you want to pass on this one! |
Member
It looks like |
samcunliffe
reviewed
Feb 2, 2026
| from the root of the project repository. Note that `uv>=0.6.7` is required to use the `--group` option. | ||
|
|
||
| <details><summary>Using venv as an alternative to uv </summary> <!-- markdownlint-disable-line MD033 --> | ||
| <details markdown="1"><summary markdown="span">Using venv as an alternative to uv </summary> <!-- markdownlint-disable-line MD033 --> |
Collaborator
Author
There was a problem hiding this comment.
My limited understanding of this is that these attributes give extra information to the Kramdown Markdown processor to avoid it mangling the HTML blocks. I found them from a blog post which references a GitHub issue on GitHub Docs repository.
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.
Resolves #577
Moves template tutorial under website
docs/pagesdirectory and updates internal links to point to new location.To get GFM admonitions to render on Jekyll site also adds jekyll-gdm-admonitions plugin as a new dependency on site config and Gemfile. As an alternative we could use the built-in support for callouts / admonitions in the Just the Docs theme. This would then no longer render on GitHub though.
I have currently updated the link on main README to still be version on GitHub rather than rendered website - not sure if we want to change this or not.
The additional attributes on
<details>/<summary>tags are taken from this blog post.