Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update mkdocs and add dark mode #802

Merged
merged 1 commit into from
Nov 9, 2024

Conversation

carlspring
Copy link
Owner

@carlspring carlspring commented May 20, 2024

Pull Request Description

This pull request closes #708 .

Acceptance Test

  • Building the code with gradle clean build still works.

Questions

  • Does this pull request break backward compatibility?

  • Does this pull request require other pull requests to be merged first?

    • Yes, please see #...
    • No
  • Does this require an update of the documentation?

    • Yes, please see [provide details here]
    • No

Summary by CodeRabbit

  • Documentation

    • Commented out license text in Apache 2.0 and a line in the main documentation index.
    • Updated MIT license text inclusion method.
    • Adjusted theme settings, plugin configurations, markdown extensions, social links, and navigation structure in mkdocs.yml.
  • Chores

    • Upgraded image version in docker-compose.yml to squidfunk/mkdocs-material:9.
    • Updated various dependencies in requirements.txt.

docs/content/index.md Outdated Show resolved Hide resolved
docs/mkdocs.yml Outdated Show resolved Hide resolved
docs/requirements.txt Outdated Show resolved Hide resolved
@carlspring
Copy link
Owner Author

@coderabbitai review

This comment was marked as outdated.

This comment was marked as outdated.

coderabbitai[bot]

This comment was marked as outdated.

@steve-todorov steve-todorov force-pushed the issues/708/mkdocs-dark-mode branch 4 times, most recently from 11029f1 to 5bbe92b Compare November 9, 2024 19:46
@steve-todorov steve-todorov changed the title feat: Dark mode for mkdocs docs: Update mkdocs and add dark mode Nov 9, 2024
@steve-todorov steve-todorov marked this pull request as ready for review November 9, 2024 19:49
@steve-todorov steve-todorov force-pushed the issues/708/mkdocs-dark-mode branch from 5bbe92b to 7488211 Compare November 9, 2024 19:59
@steve-todorov steve-todorov force-pushed the issues/708/mkdocs-dark-mode branch from 7488211 to 2bf1fab Compare November 9, 2024 20:52
@steve-todorov steve-todorov merged commit 4c09198 into master Nov 9, 2024
5 checks passed
@steve-todorov steve-todorov deleted the issues/708/mkdocs-dark-mode branch November 9, 2024 21:02
@steve-todorov steve-todorov mentioned this pull request Nov 9, 2024
@github-actions github-actions bot mentioned this pull request Nov 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Set up dark mode for mkdocs
2 participants