Skip to content

GitLab

Unverified Commit c594cbf5 authored by Reid's avatar Reid Committed by GitHub
Browse files

[doc] small fix - mkdocs (#18996) 


Signed-off-by: default avatarreidliu41 <reid201711@gmail.com>
Co-authored-by: default avatarreidliu41 <reid201711@gmail.com>
parent a35ca765
Hide whitespace changes
Inline Side-by-side
Showing with 3 additions and 2 deletions
docs/contributing/README.md
View file @ c594cbf5
...@@ -43,11 +43,12 @@ Install MkDocs along with the [plugins](https://github.com/vllm-project/vllm/blo ...@@ -43,11 +43,12 @@ Install MkDocs along with the [plugins](https://github.com/vllm-project/vllm/blo
pip install -r requirements/docs.txt 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 #### Verify Installation
Confirm that MkDocs is correctly installed:: Confirm that MkDocs is correctly installed:
```bash ```bash
mkdocs --version mkdocs --version
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment