johanneswuerbach / backstage-plugin-techdocs-addon-mermaid

Backstage TechDocs Mermaid Addon
MIT License
43 stars 18 forks source link

Can't get this working #17

Closed marct83 closed 1 year ago

marct83 commented 1 year ago

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.

johanneswuerbach commented 1 year ago

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?

marct83 commented 1 year ago

I did..

EntityPage.tsx:

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

App.tsx

      <TechDocsAddons>
        <ReportIssue />
        <Mermaid />
      </TechDocsAddons>
johanneswuerbach commented 1 year ago

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 :(

marct83 commented 1 year ago

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

ghost commented 1 year ago

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

johanneswuerbach commented 1 year ago

Closing due to the lack of feedback.

pedrorenan commented 1 year ago

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
pedrorenan commented 1 year ago

I found solution in #5 

mkdocs-techdocs-core version