Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
abernier committed Aug 10, 2024
1 parent 5adda21 commit 49a502d
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
```sh
$ MDX=~/code/pmndrs/react-three-fiber/docs NEXT_PUBLIC_LIBNAME="React Three Fiber" yarn dev
$ MDX=docs \
NEXT_PUBLIC_LIBNAME="React Three Fiber" \
BASE_PATH= \
DIST_DIR= \
yarn dev
```

http://localhost:3000/getting-started/introduction

```sh
$ MDX=docs NEXT_PUBLIC_LIBNAME="React Three Fiber" yarn build
$ rm -rf out; \
MDX=~/code/pmndrs/react-three-fiber/docs \
NEXT_PUBLIC_LIBNAME="React Three Fiber" \
BASE_PATH= \
DIST_DIR= \
yarn build; \
npx serve out
```

http://localhost:3000/getting-started/introduction

| var | description | default |
| ----------------------- | --------------------------------------------------------- | ------- |
| `MDX` | Path to `*.mdx` folder<br>NB: can be relative or absolute | `docs` |
Expand Down

0 comments on commit 49a502d

Please sign in to comment.