doc

readme.md

@@ -8,8 +8,10 @@ $ MDX=docs NEXT_PUBLIC_LIBNAME="React Three Fiber" yarn build
 
 | var                     | description                                               | default |
 | ----------------------- | --------------------------------------------------------- | ------- |
-| `MDX`                   | Path to `*.mxd` folder<br>NB: can be relative or absolute | `docs`  |
+| `MDX`                   | Path to `*.mdx` folder<br>NB: can be relative or absolute | `docs`  |
 | `NEXT_PUBLIC_LIBNAME`\* | Library name                                              | none    |
+| `BASE_PATH`             | base path for the final URL                               | none    |
+| `DIST_DIR`              | Path to the output folder                                 | `out`   |
 
 \* Required
 
@@ -20,15 +22,20 @@ $ docker build -t pmndrs-docs .
 ```
 
 ```sh
-$ export BASE_PATH=/foo; \
+$ cd ~/code/pmndrs/uikit
+$ export BASE_PATH=/uikit; \
   export MDX=./docs; \
-  export NEXT_PUBLIC_LIBNAME="pmndrs"; \
+  export NEXT_PUBLIC_LIBNAME="Uikit"; \
   \
-  rm -rf "$MDX/out" && docker run --rm --init -it \
+  rm -rf "$MDX/out"; \
+  docker run --rm --init -it \
     -v "$MDX":/app/docs \
     -e BASE_PATH \
-    -e DIST_DIR=docs/out \
+    -e DIST_DIR="$MDX/out$BASE_PATH" \
     -e MDX \
     -e NEXT_PUBLIC_LIBNAME \
-    pmndrs-docs yarn build
+    pmndrs-docs yarn build; \
+  npx -y serve "$MDX/out"
 ```
+
+Then go to http://localhost:3000/uikit/getting-started/introduction