From 8e717afe10318c4b78d75550603f72b782a3f75a Mon Sep 17 00:00:00 2001 From: LLytho Date: Fri, 26 Jul 2024 20:38:25 +0200 Subject: [PATCH] Add readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..25c6963 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Some commands to start everything in development + +## Launch dev server + +You can launch a dev server of a wiki by using `npm run dev wikis/name-of-wiki`, e.g. `npm run dev wikis/lootjs` if you want to launch lootjs. +After the dev server builds it will print out the link to the dev server. +Updating the markdown files will automatically update the dev server. + +You can run multiple dev servers at a time. + +## Build specific wiki + +You can build a specific wiki by using `npm run build wikis/name-of-wiki`, e.g. `npm run build wikis/lootjs` if you want to build lootjs. + +## Static dev server + +With `npm run serve:static` you can start a static server to test the full wiki. The static server does not automatically updates when you update the markdown files. + +## Build the wiki + +With `npm run build:static` you can build the full wiki