-
Notifications
You must be signed in to change notification settings - Fork 3.9k
<
8000
/div>
Enable code highlighting in the docs#4319
Merged
Conversation
Contributor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enables code highlighting functionality in the documentation by adding PyMdown Extensions to the MkDocs configuration and standardizing dependency management across different deployment environments.
- Added markdown extensions for syntax highlighting, code snippets, and enhanced formatting
- Consolidated dependencies into a centralized requirements.txt file
- Updated Docker and GitHub Actions workflows to use the new requirements file
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| mkdocs.yml | Added markdown extensions for code highlighting and enhanced formatting features |
| docs/requirements.txt | Created centralized dependency list with version constraints |
| docs/Dockerfile | Refactored to use requirements.txt instead of individual pip installs |
| .github/workflows/docs.yml | Updated to install dependencies from requirements.txt |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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
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.
No description provided.