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

update preview pictures #289

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

update preview pictures #289

wants to merge 2 commits into from

Conversation

2bndy5
Copy link
Collaborator

@2bndy5 2bndy5 commented Dec 23, 2024

Now includes light and dark theme variants of screenshots.

The README will only render (on github) the relevant picture based on the user's preference. See github docs. Browse this branch's README to see behavior (when switching between light and dark theme using github's command palette or user settings).

Updated mkdocs build similarly, but uses CSS instead of raw HTML. Browse this PR's RTD build to see behavior.

@2bndy5 2bndy5 added the documentation Improvements or additions to documentation label Dec 23, 2024
@2bndy5
Copy link
Collaborator Author

2bndy5 commented Dec 23, 2024

I'm leaving this as a draft until cpp-linter/cpp-linter#135 is merged/released. Some of the screenshots show latest changes that aren't released yet.

Now includes light and dark theme variants of screenshots.

The README will only render (on github) the relevant picture based on the user's preference. See [github docs](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#specifying-the-theme-an-image-is-shown-to)

Updated mkdocs build similarly, but uses CSS instead of raw HTML.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant