Use codehike for better annotations in the docs #25
Conversation
This file contains 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
✅ Deploy Preview for docs-geoconnex-us ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@webb-ben for the sake of time I am not going to use all the fancy annotations, but we now have the ability to fold code sections / highlight them , make inline callouts etc all from markdown switched the code block theme to nord since i think it looks better and matches our water theme. |
webb-ben
approved these changes
Oct 3, 2024
|
Still blocked on a potential upstream issue. Will merge this one it is resolved. Either way, most of the work is done here so should be relatively quick one the fix is applied. |
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.
Quite excited for this. Codehike support is now in docusaurus so we can now annotate our json files or add helpful effects like highlighting, footnotes, folding, etc. I think this will help improve the UX for reading through the docs and be less overwhelming to the user when we present large JSON documents.
Full list of effects is here: https://codehike.org/docs/code/link
Plan to add code hike support for location/dataset oriented pages