README: add test-server.sh script to facilitate development

This commit is contained in:
Antoine Martin 2024-06-18 21:01:18 -04:00
parent 7de5b4bd77
commit a9fef01ee0
Signed by: ayakael
GPG key ID: D62A472A4AA7D541
3 changed files with 38 additions and 7 deletions

View file

@ -28,13 +28,7 @@ To work locally with this project, you'll have to follow the steps below:
* [source][]
1. Clone the submodules: `git submodule init && git submodule update`
1. Generate the website: `ikiwiki --setup ikiwiki.setup`
1. Preview your project: open `public/index.html` in a browser
Note that the link to certain objects (like images, css) will be broken
when testing locally. To test a specific page, please add
`<base href="/full/path/to/public" />` at the top of the html file
that you want to preview. You may have to adjust absolute links
to point to relative links (i.e, make `/` into `./`).
1. Start http-server: ./test-server.sh
Read more at ikiwiki's [documentation][].