22 lines
348 B
Markdown
22 lines
348 B
Markdown
|
# Documentation
|
||
|
|
|
||
|
|
This is the home of the new documentation for uv.
|
||
|
|
|
||
|
|
The documentation is a work in progress and not ready for external references.
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Install mdbook:
|
||
|
|
|
||
|
|
```
|
||
|
|
cargo install mdbook
|
||
|
|
```
|
||
|
|
|
||
|
|
To run the documentation locally:
|
||
|
|
|
||
|
|
```
|
||
|
|
mdbook watch docs --open
|
||
|
|
```
|
||
|
|
|
||
|
|
The documentation is published to GitHub Pages on merge to `main`.
|