search

alan-turing-institute / trustchain

Trustworthy decentralised PKI
https://alan-turing-institute.github.io/trustchain/
Apache License 2.0
11 stars 5 forks source link

New documentation site built with Material for MkDocs #186

Closed thobson88 closed 4 months ago

thobson88 commented 4 months ago

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.

sgreenbury commented 4 months ago

Looks good to me!