Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
LLytho committed Jul 26, 2024
1 parent 5cb037b commit 8e717af
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 8e717af

Please sign in to comment.