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
85 stars 61 forks source link

Upgrade mkdocs-material to 7.1.0 #23

Closed dtuite closed 3 years ago

dtuite commented 3 years ago

I've tested this on a test doc I have. It looks the same for the most part. The only problem I see is that syntax highlighting is no longer working.

This patch (running on localhost):

Screenshot 2021-04-09 at 22 41 17

The previous release, running on a server (see: https://demo.roadie.so/catalog/default/component/sample-service-1/docs/feature-testing/)

Screenshot 2021-04-09 at 22 41 57

Best I can tell, this is because they started using CSS variables to define the syntax colors.

This patch (running on localhost). See the var(--md-code-fg-color) in the styles panel.

Screenshot 2021-04-09 at 22 44 09

The previous release, with the same token highlighted.

Screenshot 2021-04-09 at 22 45 17

Here's the upgrade guide for mkdocs-material. We're going through 2 major bumps. 5.x -> 7.1.0.

I'm working through this in order to try and find the root cause for https://github.com/backstage/backstage/issues/5276 and https://github.com/backstage/backstage/issues/5264

dtuite commented 3 years ago

I'm learning more about the issues and limitations surrounding this in https://github.com/backstage/backstage/issues/3998 and https://github.com/backstage/backstage/issues/5279. How naive of me to think this would be easy! 😄