integrations icon indicating copy to clipboard operation
integrations copied to clipboard

Add Snippets support to Github Files

Open ntindle opened this issue 6 months ago • 4 comments

We're looking at migrating over from mkdocs-material and one of the features we use heavily is snippets based on https://facelessuser.github.io/pymdown-extensions/extensions/snippets/

This brings over a simple version of that to cover our needs

ntindle avatar May 28 '25 18:05 ntindle

⚠️ No Changeset found

Latest commit: 74ecc520bc928aa3274aec8bf1db995cfbf3d225

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar May 28 '25 18:05 changeset-bot[bot]

Hey @ntindle I'll take a look over the weekend and make sure that we support it, through this PR or another

SamyPesse avatar May 30 '25 23:05 SamyPesse

Some of the things we'd want to add, but don't need

  • Support for showing by owner/repo, branch, and tag
  • support for branches on previews showing docs correctly

multi snippets in one code block image

ntindle avatar Jun 02 '25 15:06 ntindle

maybe fixes #446

ntindle avatar Jun 04 '25 19:06 ntindle