From 07da61adffedbc814da09051afc7476d45aedf63 Mon Sep 17 00:00:00 2001 From: Earl Warren Date: Mon, 23 Oct 2023 16:21:47 +0200 Subject: [PATCH] README: hint about how the URL of the preview is constructed --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index dba4e5e1..96ce9f7e 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,10 @@ pnpm run preview This command will clone the [website repo](https://codeberg.org/forgejo/forgejo) and launch a local development server. The current docs branch will be opened in the browser. +The URL to the documentation preview looks like +`http://localhost:4321/docs/{branch}/` where `{branch}` is the +name of the current branch from which the preview is run. + Modifications can be made to the docs while the dev server is running, and the preview will live-reload. #### Linting and formatting