Code Block inside a collapsable Admonitions #3398
-
|
Is it possible to include a syntax coloured code block inside a collapsible Admonitions. This would be quite helpful for me but I cannot seem to find a way of doing it. Thanks |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments 6 replies
-
|
Do you mean something like this? https://facelessuser.github.io/pymdown-extensions/extensions/details/#syntax |
Beta Was this translation helpful? Give feedback.
-
|
They work just like Admonitions, but they are collapsible. You can put code or whatever in them. |
Beta Was this translation helpful? Give feedback.
-
|
Yes, the documentation even includes several examples, e.g. in the Docker installation guide:
Source: ??? question "How to add plugins to the Docker image?"
Material for MkDocs only bundles selected plugins in order to keep the size
of the official image small. If the plugin you want to use is not included,
create a new `Dockerfile` and extend the official Docker image:
``` Dockerfile
FROM squidfunk/mkdocs-material
RUN pip install ...
```
Next, you can build the image with the following command:
```
docker build -t squidfunk/mkdocs-material .
```
The new image can be used exactly like the official image. |
Beta Was this translation helpful? Give feedback.
-
|
Is it possible to have more content with multiple lines, code blocks, etc. in the question? Something like this (a toy project of mine built with Sphinx + reST, those QA blocks are coded by myself with a dozen lines of CSS and JS, they are not a feature of my Sphinx theme).
If not possible at the moment, would it be something worth adding to the the theme, or best left to whoever needs to implement them manually by extending the theme, like I did in the Sphinx case? |
Beta Was this translation helpful? Give feedback.
-
|
Yes, you can nest arbitrary content inside an admonition, including code blocks and even admonitions themselves. |
Beta Was this translation helpful? Give feedback.
-
|
Sorry, I did not express myself clearly. Yes, that works fine and looks awesome, but I my question if it is possible to have more content inside the question, so that more content is visible in multiple lines inside the question.
|
Beta Was this translation helpful? Give feedback.
-
|
As I said, you can nest admonitions and details: |
Beta Was this translation helpful? Give feedback.
-
|
Oh, gosh, I didn't pay enough attention to the word "nest". Thanks! |
Beta Was this translation helpful? Give feedback.
Yes, the documentation even includes several examples, e.g. in the Docker installation guide:
Source:
??? question "How to add plugins to the Docker image?" Material for MkDocs only bundles selected plugins in order to keep the size of the official image small. If the plugin you want to use is not included, create a new `Dockerfile` and extend the official Docker image: ``` Dockerfile FROM squidfunk/mkdocs-material RUN pip install ... ``` Next, you can build the image with the following command: ``` docker build -t squidfunk/mkdocs-material . ``` The new image can be used exactly like the official image.