From 3ca2ecd75fe68c728e04aacd41e1da5750ef0473 Mon Sep 17 00:00:00 2001 From: this-is-tobi Date: Sun, 10 Nov 2024 14:33:08 +0100 Subject: [PATCH] docs: improve quickstart section in readme --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f6f3fd6..24e1a16 100644 --- a/README.md +++ b/README.md @@ -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 + ``` + > 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 -``` +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 : . ## Rules