[Docs] Update README.md MkDocs to give option to run dev-server on different port. (#54584)
Signed-off-by: jcayab <42927334+jcayab@users.noreply.github.com> Signed-off-by: Jefrey Cayab <jcayab@gmail.com> Signed-off-by: Jefrey Cayab <42927334+jcayab@users.noreply.github.com> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com> Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
This commit is contained in:
co-authored by
Claude Sonnet 5
Harry Mellor
parent
68dcc4fd86
commit
de650b55af
@@ -120,15 +120,15 @@ uv pip install -r requirements/docs.txt
|
||||
(e.g., `mkdocs-awesome-nav` requires Python 3.10+)
|
||||
|
||||
MkDocs comes with a built-in dev-server that lets you preview your documentation as you work on it.
|
||||
From the root of the repository, run:
|
||||
From the root of the repository, run the following. Note that by default, the dev-server will run on `127.0.0.1:8000`. Should you want to run the dev-server on a different port, use `-a` like this `mkdocs serve -a localhost:8090`.
|
||||
|
||||
```bash
|
||||
mkdocs serve # with API ref (~10 minutes)
|
||||
API_AUTONAV_EXCLUDE=vllm mkdocs serve # API ref off (~15 seconds)
|
||||
```
|
||||
|
||||
Once you see `Serving on http://127.0.0.1:8000/` in the logs, the live preview is ready!
|
||||
Open <http://127.0.0.1:8000/> in your browser to see it.
|
||||
Once you see a `Serving on http://<address>:<port>/` line in the logs, the live preview is ready!
|
||||
Open that address in your browser to see it — `http://127.0.0.1:8000/` by default, or whichever host/port you passed to `-a`.
|
||||
|
||||
For additional features and advanced configurations, refer to the:
|
||||
|
||||
|
||||
@@ -52,6 +52,9 @@ source ~/.venv-vllm-metal/bin/activate
|
||||
vllm serve
|
||||
```
|
||||
|
||||
Wait for 2-3 minutes until you see application startup complete:
|
||||
> INFO: Application startup complete.
|
||||
|
||||
Once the server is running, you have multiple options to interact with it:
|
||||
|
||||
#### Option 1: Interactive chat
|
||||
|
||||
Reference in New Issue
Block a user