Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Styling of the Admonition extension for Markdown is not correct #64

Closed
madrus opened this issue Nov 28, 2016 · 5 comments
Closed

Styling of the Admonition extension for Markdown is not correct #64

madrus opened this issue Nov 28, 2016 · 5 comments
Assignees
Labels
change request Issue requests a new feature or improvement resolved Issue is resolved, yet unreleased if open
Milestone

Comments

@madrus
Copy link

madrus commented Nov 28, 2016

Description

Styling of the Admonition extension for Markdown is not correct.

Expected behavior

These are the standard colors I see with MkDocs with the standard RTD theme:

  • note, seealso - light blue
  • important, hint, tip - green
  • warning, caution, attention - beige-brown
  • danger, error - pink

Actual behavior

  • no matter the word, everything is light blue
  • only the word warning gives red color (instead of beige-brown)

Steps to reproduce the bug

  1. create two projects: one with MkDocs standard and one with Material.
  2. mkdocs.yml:
    markdown_extensions: 
      - admonition
  3. add this to any .md page:
    !!! note "Explicit title within double quotes"
        Any number of other indented markdown elements.
    
  4. play around substituting the word note with all of the above mentioned in both projects.

Package versions

  • Python: 2.7.12
  • MkDocs: 0.16.0
  • Material: 0.2.4

System information

  • OS: Windows 10
  • Browser: Chrome (I have not tested with other browsers)
@squidfunk
Copy link
Owner

Already fixed in upcoming 1.0.0

@squidfunk squidfunk added this to the 1.0.0 milestone Nov 28, 2016
@squidfunk squidfunk self-assigned this Nov 28, 2016
@squidfunk squidfunk added the change request Issue requests a new feature or improvement label Nov 28, 2016
@squidfunk squidfunk added the resolved Issue is resolved, yet unreleased if open label Dec 26, 2016
@facelessuser
Copy link
Contributor

Caution seems to be rendered the same color as Danger and Error in the latest pre-release. I think it should be rendered like Warning.

@facelessuser
Copy link
Contributor

facelessuser commented Jan 3, 2017

Never mind. I took a look at the rework branches doc and see that you have purposely categorized the types different than the default mkdocs themes do. I hadn't thought to look at the unpublished docs (I was still looking at the old ones) to see if the types were documented. As they appear to be well documented and purposefully categorized as they are, I don't think there is a problem here.

@squidfunk
Copy link
Owner

It makes sense to adhere to the Readthedocs theme, as it is very widely used. So I think it's a good point you made, because it minimizes switching cost.

@squidfunk
Copy link
Owner

The RTD admonition functionality is now completely mirrored + the ones Material adds (e.g. summary, bug etc). Fixed in 45208de

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
change request Issue requests a new feature or improvement resolved Issue is resolved, yet unreleased if open
Projects
None yet
Development

No branches or pull requests

3 participants