Wrap code snippets in fences and adjust homepage mascot style - #212
Merged
Conversation
The `--8<--` pymdownx.snippets directive on four example pages was placed as raw markdown without a surrounding fenced code block, causing the included Python source to render as plain text instead of a highlighted code block. Wrap each include inside ```python fences so the examples display correctly with syntax highlighting. Also resize and center the homepage mascot to match the tryx docs style.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This pull request updates the documentation to improve code example embedding and enhance the visual presentation of the project homepage. The most notable changes include embedding example source code directly into the documentation and updating the main page's mascot image for better alignment and sizing.
Documentation improvements:
--8<--directive, making it easier for users to view and reference the actual code. This change affectsdocs/examples/basic-bot.md,docs/examples/async-bot.md,docs/examples/interactive-async.md, anddocs/examples/multi-session.md. [1] [2] [3] [4]Homepage visual update:
docs/index.md) for improved appearance and consistency.The--8<--pymdownx.snippets directive on four example pages was placed as raw markdown without a surrounding fenced code block, causing the included Python source to render as plain text instead of a highlighted code block. Wrap each include inside ```python fences so the examples display correctly with syntax highlighting.Also resize and center the homepage mascot to match the tryx docs style.