feat: Dark mode for mkdocs #802
Conversation
| [//]: # (```) | ||
|
|
||
| [//]: # (--8<-- "../LICENSE.Apache-2.0.md") | ||
|
|
||
| [//]: # (```) |
There was a problem hiding this comment.
@steve-todorov : Temporarily broken.
|
|
||
| [//]: # (```) | ||
|
|
||
| [//]: # (--8<-- "../LICENSE.MIT.md") | ||
|
|
||
| [//]: # (```) |
There was a problem hiding this comment.
@steve-todorov : Temporarily broken.
|
|
||
| [//]: # ( --8<-- "../src/test/resources/amazon-test-sample.properties") |
There was a problem hiding this comment.
@steve-todorov : Temporarily broken.
| # - mdx_gh_links | ||
| # - mdx_include: | ||
| # base_path: ./content |
There was a problem hiding this comment.
@steve-todorov : These no longer seem to work.
| # This dependency is necessary for older mkdocs versions. | ||
| # TODO: Remove when upgrading mkdocs. | ||
| jinja2<3.1.0 | ||
| #jinja2<3.1.0 |
There was a problem hiding this comment.
@steve-todorov : Not sure if we need this.
|
@coderabbitai review |
Actions performedReview triggered.
|
WalkthroughThis update primarily focuses on enhancing the documentation setup and dependencies. Key changes include the implementation of dark mode for mkdocs, updates to documentation files, and upgrades to dependencies and Docker images. These changes aim to improve the user experience and maintain compatibility with the latest tools and libraries. Changes
Assessment against linked issues
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range and nitpick comments (2)
docs/requirements.txt (1)
14-14: Consider removing or updating the commented-out dependency.It's generally a good practice to clean up commented-out code if it's no longer needed, or update the comment to reflect why it's still there.
docs/content/index.md (1)
Line range hint
3-6: Check for potential typos or repeated words as flagged by LanguageTool.While these might be false positives, it's good practice to review them to ensure clarity and professionalism in documentation.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (6)
- docs/content/contributing/legal/license-Apache-2.0.md (1 hunks)
- docs/content/contributing/legal/license-MIT.md (1 hunks)
- docs/content/index.md (1 hunks)
- docs/docker-compose.yml (2 hunks)
- docs/mkdocs.yml (6 hunks)
- docs/requirements.txt (1 hunks)
Files skipped from review due to trivial changes (3)
- docs/content/contributing/legal/license-Apache-2.0.md
- docs/content/contributing/legal/license-MIT.md
- docs/docker-compose.yml
Additional context used
LanguageTool
docs/content/index.md
[duplication] ~41-~41: Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Context: ...you will get403 Forbiddenerrors. 4. SelectAttach an existing policies directly5. SelectAmazonS3FullAccesspolicy and `Create...
[style] ~43-~43: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 680 characters long) (EN_EXCESSIVE_EXCLAMATION)
Context: ...t access key` - you will need them later! ### Example === "1. Configure" C...
Markdownlint
docs/content/index.md
1-1: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
5-5: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
6-6: Expected: 0 or 2; Actual: 4 (MD009, no-trailing-spaces)
Trailing spaces
22-22: Expected: 0 or 2; Actual: 4 (MD009, no-trailing-spaces)
Trailing spaces
28-28: Expected: 0 or 2; Actual: 4 (MD009, no-trailing-spaces)
Trailing spaces
33-33: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
74-74: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
75-75: Unused link or image reference definition: "<--# links -->" (MD053, link-image-reference-definitions)
Link and image reference definitions should be needed
Additional comments not posted (3)
docs/requirements.txt (1)
1-11: Ensure all dependency versions are compatible with each other and with the project.docs/mkdocs.yml (2)
118-121: Ensure the social links are updated and correct.This update helps maintain the relevance and accuracy of the contact information.
17-31: Verify the new dark mode toggle configuration.Ensure that the toggle behaves as expected across different browsers and devices.
Verification successful
The dark mode configuration is present in the
mkdocs.ymlfile, as confirmed by the script output. The configuration includes themedia,scheme,toggle icon, andtoggle namesettings for dark mode.
- : The dark mode toggle configuration is correctly set in the
mkdocs.ymlfile. Please manually verify the toggle functionality in the MkDocs site to ensure it behaves as expected across different browsers and devices.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the dark mode toggle works correctly. # Test: Manually check the toggle in the MkDocs site. echo "Please manually verify the dark mode toggle in the MkDocs site."Length of output: 136
Script:
#!/bin/bash # Description: Verify the presence of dark mode configuration in mkdocs.yml # Check for the dark mode palette settings in the mkdocs.yml file grep -A 5 'media: "(prefers-color-scheme: dark)"' docs/mkdocs.ymlLength of output: 230
|
|
||
| [//]: # ( --8<-- "../src/test/resources/amazon-test-sample.properties") |
There was a problem hiding this comment.
Clarify the reason for commenting out the properties file path.
It's important to document why certain code segments are commented out to maintain clarity for other developers.
| # - markdownextradata: {} | ||
| - minify: | ||
| minify_html: true | ||
|
|
||
| markdown_extensions: | ||
| - admonition | ||
| - attr_list | ||
| - footnotes | ||
| - meta | ||
| - mdx_gh_links | ||
| - mdx_include: | ||
| base_path: ./content | ||
| # - mdx_gh_links | ||
| # - mdx_include: | ||
| # base_path: ./content |
There was a problem hiding this comment.
Review the commented-out plugins to ensure they are no longer needed.
If these plugins are commented out for a reason, such as compatibility issues, please document it clearly. If they are no longer needed, consider removing them to clean up the configuration file.
Pull Request Description
This pull request closes #708 .
Acceptance Test
gradle clean buildstill works.Questions
Does this pull request break backward compatibility?
Does this pull request require other pull requests to be merged first?
Does this require an update of the documentation?
Summary by CodeRabbit
Documentation
mkdocs.yml.Chores
docker-compose.ymltosquidfunk/mkdocs-material:9.requirements.txt.