docs: update Oranda, fix syntax highlighting #304
Merged
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
This commit updates Oranda from v0.3.1 to v0.6.1. I don't believe any of the new Oranda features are particularly relevant to us, but there are some nice bugfixes, including axodotdev/oranda#654, which fixes unreadable CSS colors for mdBook draft chapters in the Oranda CSS themes which we use. Also, since axodotdev/oranda#609 has merged upstream, we can change the Nix flake to depend on upstream Oranda rather than my fork.
Oranda doesn't know how to highlight "console", it does know how to highlight "shell": ``` esp32c3-buddy ⚠ >o_o< WARNING: Found syntax highlight language annotation `console` which is not currently supported. The annotated block will be shown as plaintext. Please file an issue https://github.com/axodotdev/oranda/issues/new to let us know you'd like to see it supported. esp32c3-buddy ⚠ >o_o< WARNING: Found syntax highlight language annotation `console` which is not currently supported. The annotated block will be shown as plaintext. Please file an issue https://github.com/axodotdev/oranda/issues/new to let us know you'd like to see it supported. esp32c3-buddy ⚠ >o_o< WARNING: Found syntax highlight language annotation `console` which is not currently supported. The annotated block will be shown as plaintext. Please file an issue https://github.com/axodotdev/oranda/issues/new to let us know you'd like to see it supported. esp32c3-buddy ⚠ >o_o< WARNING: Found syntax highlight language annotation `console` which is not currently supported. The annotated block will be shown as plaintext. Please file an issue https://github.com/axodotdev/oranda/issues/new to let us know you'd like to see it supported. esp32c3-buddy ⚠ >o_o< WARNING: Found syntax highlight language annotation `console` which is not currently supported. The annotated block will be shown as plaintext. Please file an issue https://github.com/axodotdev/oranda/issues/new to let us know you'd like to see it supported. ``` GitHub's Markdown renderer treats these as equivalent, so switching the code blocks currently marked as "console" to "shell" results in much nicer syntax highlighting in the Oranda site without changing the way the READMEs look on GitHub.
hawkw
force-pushed
the
eliza/update-oranda
branch
from
6319092 to
3b45e2b
Compare
hawkw
added a commit
that referenced
this pull request
Jan 19, 2024
This commit updates Oranda from v0.3.1 to v0.6.1. I don't believe any of the new Oranda features are particularly relevant to us, but there are some nice bugfixes, including axodotdev/oranda#654, which fixes unreadable CSS colors for mdBook draft chapters in the Oranda CSS themes which we use. Also, since axodotdev/oranda#609 has merged upstream, we can change the Nix flake to depend on upstream Oranda rather than my fork.
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.
chore: update Oranda
This commit updates Oranda from v0.3.1 to v0.6.1. I don't believe any of
the new Oranda features are particularly relevant to us, but there are
some nice bugfixes, including draft mdBook chapter titles are unreadable in
oranda-darkandoranda-lightmdBook theme axodotdev/oranda#654, which fixesunreadable CSS colors for mdBook draft chapters in the Oranda CSS themes
which we use.
Also, since Fix the tailwind dependency breaking the Nix flake axodotdev/oranda#609 has merged upstream, we can change the
Nix flake to depend on upstream Oranda rather than my fork.
docs: change "console" markdown syntax to "shell"
Oranda doesn't know how to highlight "console", it does know how to
highlight "shell":
GitHub's Markdown renderer treats these as equivalent, so switching the
code blocks currently marked as "console" to "shell" results in much
nicer syntax highlighting in the Oranda site without changing the way
the READMEs look on GitHub.