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

Changing admonition icon set not working #172

Open
5nafu opened this issue Feb 29, 2024 · 4 comments
Open

Changing admonition icon set not working #172

5nafu opened this issue Feb 29, 2024 · 4 comments
Labels

Comments

@5nafu
Copy link

5nafu commented Feb 29, 2024

We are currently trying to change the admonition icons as explained in the material theme documentation.

Our mkdocs.yaml looks like this:

site_name: '...'
site_description: '...'
#uncomment the below lines if you want to enable the edit button in your techdocs
edit_uri: blob/main/docs/ #don't change it, just uncomment
repo_url: '...'
theme:
  name: material
  palette:
    scheme: default
  features:
    - toc.follow
    - navigation.indexes
    - content.code.copy
    - content.code.annotate
  icon:
    admonition:
      example: fontawesome/solid/flask
plugins:
  - techdocs-core
  - awesome-pages
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - mdx_truly_sane_lists:
      nested_indent: 4

Unfortunately, the icons stay the same when we try to run a preview of the documentation with npx @techdocs/cli serve. If we switch to mkdocs (mkdocs serve) directly, the icons work as expected.

We found an issue squidfunk/mkdocs-material#3987 suggesting that removing the palette setting might solve the issue, but this did not help in out case.

@vishes-shell
Copy link

@5nafu sorry to interrupt, it's not really about changeing admonition icom.

Have you managed to make annotate working within backstage instance?

i have:

  • mkdocs serve - works
  • techdocs-cli build - works
  • techdocs page within backstage - don't work

i really want to make it work within backstage...

@daneah
Copy link

daneah commented Jun 7, 2024

@vishes-shell According to #128 code annotation isn't supported for (understandable) deeper architectural reasons, but I am curious as well.

@vanchaxy
Copy link

@vishes-shell @daneah I have updated #128 with a solution for annotation support if you are still interested

Copy link

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale label Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants