search

backstage / mkdocs-techdocs-core

The core MkDocs plugin used by Backstage's TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown extensions
Apache License 2.0
83 stars 61 forks source link

feat: add mkdocs-jupyter plugin #64

Closed nadworny closed 10 months ago

nadworny commented 2 years ago

This introduces support for the mkdocs-jupyter plugin.

nadworny commented 2 years ago

Hi there,

I would appreciate some help :) as suggested, I have included my local version of mkdocs-techdocs-core in a Dockerfile which I use for my backstage deployment, but I'm getting the following error while opening my techdocs:

space-backstage-backstage-1  | 2022-05-17T19:14:00.228Z techdocs error Failed to build the docs page: Failed to generate docs from /space into /tmp/techdocs-tmp-HDHqU0; caused by unknown error 'Command mkdocs failed, exit code: 1' Failed to generate docs from /space into /tmp/techdocs-tmp-HDHqU0; caused by unknown error 'Command mkdocs failed, exit code: 1' type=plugin name=Error cause=undefined stack=Error: Failed to generate docs from /space into /tmp/techdocs-tmp-HDHqU0; caused by unknown error 'Command mkdocs failed, exit code: 1'
space-backstage-backstage-1  |     at _TechdocsGenerator.run (/app/node_modules/@backstage/plugin-techdocs-node/dist/index.cjs.js:412:13)
space-backstage-backstage-1  |     at runMicrotasks (<anonymous>)
space-backstage-backstage-1  |     at processTicksAndRejections (node:internal/process/task_queues:96:5)
space-backstage-backstage-1  |     at async DocsBuilder.build (/app/node_modules/@backstage/plugin-techdocs-backend/dist/index.cjs.js:137:5)
space-backstage-backstage-1  |     at async DocsSynchronizer.doSync (/app/node_modules/@backstage/plugin-techdocs-backend/dist/index.cjs.js:222:23)
space-backstage-backstage-1  |     at async /app/node_modules/@backstage/plugin-techdocs-backend/dist/index.cjs.js:520:7

Do you see anything important missing in the implementation? Or do you have any idea what I might be doing wrong?

abi-jey commented 2 years ago

Is there any update on this?

nadworny commented 1 year ago

hi @ottosichert / @freben (sorry for mentioning but you're the only ones I know from the backstage project from my previous PRs) - do you know if this repo is still active? Any help would be appreciated...

nadworny commented 1 year ago

I guess this repo is dead? 😢

agentbellnorm commented 10 months ago

@nadworny to answer your (old) question: Did you list the plugin under the plugins key in mkdocs.yaml?

Generally we don't want to add more plugins to this core repo as not everyone will use it. I have a PR to add some instructions on how to use mkdocs plugins here: https://github.com/backstage/backstage/pull/19607