From c594cbf56546f74e8042018477ca25d1ee95613a Mon Sep 17 00:00:00 2001 From: Reid <61492567+reidliu41@users.noreply.github.com> Date: Sun, 1 Jun 2025 11:23:43 +0800 Subject: [PATCH] [doc] small fix - mkdocs (#18996) Signed-off-by: reidliu41 Co-authored-by: reidliu41 --- docs/contributing/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/contributing/README.md b/docs/contributing/README.md index 72c4909b16119..6216a3d16afb3 100644 --- a/docs/contributing/README.md +++ b/docs/contributing/README.md @@ -43,11 +43,12 @@ Install MkDocs along with the [plugins](https://github.com/vllm-project/vllm/blo pip install -r requirements/docs.txt ``` -> **Note:** Ensure that your Python version is compatible with the plugins (e.g., mkdocs-awesome-nav requires Python 3.10+) +!!! note + Ensure that your Python version is compatible with the plugins (e.g., `mkdocs-awesome-nav` requires Python 3.10+) #### Verify Installation -Confirm that MkDocs is correctly installed:: +Confirm that MkDocs is correctly installed: ```bash mkdocs --version