johanneswuerbach/backstage-plugin-techdocs-addon-mermaid

Can't get this working

Closed this issue · 8 comments

I followed the steps to add the add on to backstage and all I see is...

image

My md file looks like:

image

Let me know what I should check. I've tried a few things but really can't figure it out. Thanks.

There is a TechDocsAddons block in packages/app/src/components/catalog/EntityPage.tsx and packages/app/src/App.tsx, did you modify both of them?

I did..

EntityPage.tsx:

const techdocsContent = (
  <EntityTechdocsContent>
    <TechDocsAddons>
      <ReportIssue />
      <Mermaid />
    </TechDocsAddons>
  </EntityTechdocsContent>
);

App.tsx

      <TechDocsAddons>
        <ReportIssue />
        <Mermaid />
      </TechDocsAddons>

Do you see any failures in your backstage app when starting or in the browser console?

Otherwise it will be fairly hard to reproduce and you'll probably need to dig into the code :(

I see no errors in the console or in the terminal when I go to a doc that should have a rendered mermaid diagram.

@marct83 Can you share the mkdocs.yaml file also.

Closing due to the lack of feedback.

Hello! I am same situation here. I edited EntityPage.tsx and App.tsx
this is my mkdocs.yaml:

site_name: 'Documentação PRTE'
nav:
  - Home: index.md
  - Padrões:
    - Fluxo de Desenvolvimento: padroes/desenvolvimento.md
    - Padrão de Documentação de Atividade: padroes/documentacao-atividades.md
    - Controle de Versão: version_control.md
    - Documentação no Swagger: swagger_documentation.md 
  - Experiência CTO: cto-experience.md
  - Templates: 
    - Análises para Desenvolvimento: docs_templates/analises-desenvolvimento.md
plugins:
  - techdocs-core

I found solution in #5 

mkdocs-techdocs-core version