foster/forgejo-docs
0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-24 18:09:26 -05:00
Code Issues Activity

README: hint about how the URL of the preview is constructed

Browse source
This commit is contained in:
Earl Warren 2023-10-23 16:21:47 +02:00
parent 88269f91ca
commit 07da61adff
No known key found for this signature in database
GPG key ID: 0579CB2928A78A00
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -63,6 +63,10 @@ pnpm run preview
This command will clone the [website repo](https://codeberg.org/forgejo/forgejo) 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. 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. Modifications can be made to the docs while the dev server is running, and the preview will live-reload.
#### Linting and formatting #### Linting and formatting