Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve mkocs setup info #463

Merged
merged 1 commit into from
Sep 13, 2024
Merged

Improve mkocs setup info #463

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions docs/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,22 @@ Refer to the

Install `python` and `pipx`, for example with brew.

Install mkdocs-material and all required dependencies:
Install `mkdocs-material` and all required dependencies in the `mkdocs-material`
virtual environment for Python:

```shell
pipx install --include-deps mkdocs-material
```
pipx install --install-deps mkdocs-material

Add plugins to the virtual environment:

```shell
pipx inject --include-deps mkdocs-material cairosvg
```

Start the local site in the project root folder:

```
```shell
cd trino-gateway
mkdocs serve
```
Expand Down