-
Notifications
You must be signed in to change notification settings - Fork 5
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
New documentation site built with Material for MkDocs #186
Merged
Conversation
This file contains 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
Prevents clipboard copying of the prompt character in code snippets tagged as 'console'. Taken from: SensorsIot/IOTstack#547
1 task
sgreenbury
reviewed
Jul 17, 2024
@@ -3,6 +3,7 @@ repos: | |||
rev: v2.3.0 | |||
hooks: | |||
- id: check-yaml | |||
args: [--unsafe] |
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.
Could exclude instead though I think this is the only yml
in the repo so the --unsafe
flag seems better
Suggested change
args: [--unsafe] | |
exclude: mkdocs\.yml |
Looks good to me! |
sgreenbury
approved these changes
Jul 17, 2024
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.
Closes #173.
New improved documentation.
Note that I hit this issue when adding these lines to
mkdocs.yml
:which are needed to render the copy-to-clipboard icon on the "Getting Started" page. Seems like
PyYAML
(latest version, 6.0.1) does not consider this valid YAML. My workaround is to set the--unsafe
flag on thecheck-yaml
pre-commit hook.