diff --git a/README.md b/README.md index 4965fb23..3484ad2c 100644 --- a/README.md +++ b/README.md @@ -21,3 +21,7 @@ It is recommended to use [Bun](https://bun.sh) as the JavaScript runtime for thi bun start ``` 1. Open http://localhost:1414/ in your web browser. + +The `bun start` command runs both Eleventy and [Pagefind](https://pagefind.app/) to build the website and create the website's search index respectively, then serve the project output in a local server. + +After creating and updating the website's search index (you can do so by simply running the `bun create-search-index` command), if you want to run the website locally again, you can instead run the `bun start-11ty` command, which runs Eleventy to build the website and serve the output in a hot-reloading local server, then open `http:localhost:8080/` in your web browser.