Mkdocs-material: Progressbar is not rendered

Created on 28 Aug 2018  路  7Comments  路  Source: squidfunk/mkdocs-material

Description

Progressbar extension shows only the label. E.g., [= 30% "30%"] or [= 30% "30%"]{: .thin} renders only as 30%.

Expected behavior

The progressbar is rendered.

Actual behavior

The progressbar is not rendered

Steps to reproduce the bug

  1. write [= 30% "30%"] into md file

Package versions

  • Python: python --version Python 3.6.5
  • MkDocs: mkdocs --version mkdocs, version 1.0.2
  • Material: pip show mkdocs-material | grep -E ^Version Version: 3.0.3

Project configuration

markdown_extensions:
  - attr_list
  - admonition
  - codehilite
  - footnotes
  - def_list
  - toc:
      permalink: true

  - pymdownx.progressbar:
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.keys

theme:
  name: 'material'
  favicon: 'img/neuron.ico'

extra_javascript:
  - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'

System information

  • OS: [The operating system you're running] Ubuntu 18.04
  • Browser: [The browser used, if relevant] Chromium 68.0.3440.106 (Official Build)

Most helpful comment

Ok thank you for the answer. I want to use the mkdocs for a project description / planning鈥搕here it is a nice-to-have feature. I got something convincing enough running in case somebody is interested:

However, I found some CSS in the docs for progressbar and added a custom stylesheed (okay, I admit that was not that hard).
Markdown overrides the margin of the label but I could fix that with adding margin: 0 ! important (there certainly is a more beautiful way for doing so but it works for me)

All 7 comments

The PyMdown extensions progressbar is not supported, as it would be stated in the docs if it was. You can, however, provide your own styles with custom CSS.

Ok, thank you. Is it a planned feature (I suck at CSS)?

Nope, it's not on the roadmap and probably never will be because it is a real niche feature.

Ok thank you for the answer. I want to use the mkdocs for a project description / planning鈥搕here it is a nice-to-have feature. I got something convincing enough running in case somebody is interested:

However, I found some CSS in the docs for progressbar and added a custom stylesheed (okay, I admit that was not that hard).
Markdown overrides the margin of the label but I could fix that with adding margin: 0 ! important (there certainly is a more beautiful way for doing so but it works for me)

Glad it works for you. The thing is that a lot of users ask things like "_can you please support this and this feature_" which constantly increases the cost of maintenance for the theme. Material already supports _a lot_ of features and is in my opinion frankly quite unrivaled in the user documentation space. Adding more and more features will overcomplicate stuff so I try to keep things as lean as possible while adding features that are needed by a lot of users like search, internationalization etc.

I did not want to raise the impression to "demand" it :smile:
Mkdocs+Material is awesome and the first out of many static website generators that really works for me.
Thank you!

I also have CSS here for progress bar https://github.com/facelessuser/pymdown-extensions/blob/master/docs/src/scss/_progressbar.scss, but you'd have to convert it to CSS. It may be a bit more materialish; it's what my docs use.

Was this page helpful?
0 / 5 - 0 ratings