search

jupyter-book / mystmd

Command line tools for working with MyST Markdown.
https://mystmd.org/guide
MIT License
219 stars 64 forks source link

Add documentation to index support #1424

Closed choldgraf closed 3 months ago

choldgraf commented 3 months ago

This adds documentation about indices to the index support PR. I tried to push to your branch directly but it was rejected so this is a PR for the same thing.

I wrote the docs because I wanted to see how the index support felt in actual usage. Hopefully this is helpful as well!

changeset-bot[bot] commented 3 months ago

⚠️ No Changeset found

Latest commit: 28ac2399e96967f26c73907c4a1381c73c5d5b7d

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

choldgraf commented 3 months ago

I'm gonna merge this in so that we can see what the previews look like