Skip to content

Commit

Permalink
docs: improve quickstart section in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
this-is-tobi committed Nov 10, 2024
1 parent 6219155 commit 3ca2ecd
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,20 @@ For optimal use of Docpress, please check the [rules section](#rules) to underst

## Quickstart

Generate website using the Docpress docker image :
1. Generate website using the Docpress docker image.
```sh
docker run --name docpress --rm -v $(pwd)/docpress:/app/docpress:rw \
ghcr.io/this-is-tobi/docpress -u <github_username>
```
> The dist folder is available at `./docpress/.vitepress/dist`, ready to be served by a web server like Nginx, Apache, etc...

```sh
docker run --name docpress --rm -v $(pwd)/docpress:/app/docpress:rw \
ghcr.io/this-is-tobi/docpress -u <github_username>
```
2. Start an Nginx docker image using the generated static folder.
```sh
docker run --name my-docs --rm -v ./docpress/.vitepress/dist:/usr/share/nginx/html:ro -p 8080:80 \
docker.io/nginx
```

The dist folder is available at `./docpress/.vitepress/dist`, ready to be delivered with a web server like Nginx, Apache, etc...
3. Access the website at the following address : <http://localhost:8080>.

## Rules

Expand Down

0 comments on commit 3ca2ecd

Please sign in to comment.