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

New documentation site built with Material for MkDocs #186

Merged
merged 64 commits into from
Jul 17, 2024
Merged

Conversation

thobson88
Copy link
Collaborator

@thobson88 thobson88 commented Jul 9, 2024

Closes #173.

New improved documentation.

Note that I hit this issue when adding these lines to mkdocs.yml:

  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

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 the check-yaml pre-commit hook.

@@ -3,6 +3,7 @@ repos:
rev: v2.3.0
hooks:
- id: check-yaml
args: [--unsafe]
Copy link
Collaborator

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

@sgreenbury
Copy link
Collaborator

Looks good to me!

@sgreenbury sgreenbury merged commit 90baff8 into main Jul 17, 2024
5 checks passed
@sgreenbury sgreenbury deleted the mkdocs branch July 17, 2024 11:02
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.

Migrate GitHub Pages site to Material for MkDocs
2 participants