一些测试例子¶
提示警告等带边框¶
Tip
If you don't have prior experience with Python, we recommend reading Using Python's pip to Manage Your Projects' Dependencies, which is a really good introduction on the mechanics of Python package management and helps you troubleshoot if you run into errors.
Warning
The Docker container is intended for local previewing purposes only and is not suitable for deployment. This is because the web server used by MkDocs for live previews is not designed for production use and may have security vulnerabilities.
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, you can add them easily:
Create a Dockerfile and extend the official image:
FROM squidfunk/mkdocs-material
RUN pip install mkdocs-macros-plugin
RUN pip install mkdocs-glightbox
Clone or fork the Insiders repository, and create a file called
user-requirements.txt in the root of the repository. Then, add the
plugins that should be installed to the file, e.g.:
mkdocs-macros-plugin
mkdocs-glightbox
Next, build the image with the following command:
docker build -t squidfunk/mkdocs-material .
The new image will have additional packages installed and can be used exactly like the official image.
Recommended: [configuration validation and auto-complete]
In order to minimize friction and maximize productivity, Material for MkDocs
provides its own [schema.json][^1] for mkdocs.yml. If your editor supports
YAML schema validation, it's definitely recommended to set it up:
Feedback wanted!
The tutorials are a recent addition to our documentation and we are still working out what shape they should have in the end. Please [provide any feedback you might have in this discussion thread].
Note, however, that suggestions should be specific and feasible. We want to focus on creating more content at the moment, instead of developing a specific styling or behaviour for the tutorials. If there are worthwhile improvements that we can make through simple customization then we are happy to consider those.
复选框等¶
- No installation needed in [Docker image]
- No installation needed in [GitHub Actions] (Ubuntu)
- 没有选中
博客¶
myfirst.md
---
date: 2023-12-31
updated: 2024-01-02
categories:
- Holidays
tags:
- new year
- hogmanay
- festive season
authors:
- zhangbinbin
- team
- squidfunk
---
# Happy new years eve!
We hope you are all having fun and wish you all the best for the new year!
<!-- more -->
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.
---
date:
created: 2024-01-01
draft: true
---
# Happy new year!
Happy 2024 to everyone. Wishing you all the best!
<!-- more -->
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.