From 7de5b4bd770b303815b9a4f9710c8e5d74a859a5 Mon Sep 17 00:00:00 2001 From: Antoine Martin Date: Tue, 18 Jun 2024 12:48:50 -0400 Subject: [PATCH] README: add instructions better local testing --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 3acc553..49dbe46 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,12 @@ To work locally with this project, you'll have to follow the steps below: 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 +`` 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 `./`). + Read more at ikiwiki's [documentation][]. ## Contributing