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

Support for admonition extension #33

Closed
mczachurski opened this issue Jun 29, 2016 · 3 comments
Closed

Support for admonition extension #33

mczachurski opened this issue Jun 29, 2016 · 3 comments

Comments

@mczachurski
Copy link

mczachurski commented Jun 29, 2016

Hi!

Could you add support for admonition extension? Admonition is simple markup which we can use to mark important part of documentation, it looks like this:

!!! note
    You should note that the title will be automatically capitalized.

Here is a more detailed description: Admonition Extension. And here is an example how it should looks rendered on the page:

capture

Example from Read The Docs page .

I've tried to implement this using IMarkdownExtension (and BlockParser), however it's really hard without documentation (and BlockParser is not so obvious).

Best regards,
Marcin.

@xoofx
Copy link
Owner

xoofx commented Jun 29, 2016

Why not using custom containers?

:::note
You should note that the title will be automatically capitalized.
::: 

With proper CSS styling it should be possible to achieve the same result.

@xoofx
Copy link
Owner

xoofx commented Jun 30, 2016

@mczachurski did you finally find your way with the custom container extension?

@mczachurski
Copy link
Author

@xoofx yes it work like a charm. Thanks.

@xoofx xoofx closed this as completed Jul 1, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants