React docs and playground
A React document tool.
- Zero config
- React
- TypeScript
- PostCSS, CSS Modules
- MDX (front matter, table of contents, syntax highlighting)
```
npm i playland --save-devOr
yarn add playland --dev
Use md/mdx docs, see examples/basic:
`bash`
.
├── README.md
├── package.json
└── docs # mdx pages
├── Foo.mdx
└── Bar.mdx
Use jsx docs, see examples/with-jsx-pages:
`bash`
.
├── .playland
│ └── config.js
├── README.md
├── package.json
├── docs # mdx pages
│ ├── Foo.mdx
│ └── bar.mdx
└── api # jsx pages
├── FooPage.jsx
└── BarPage.jsx
Optional .playland/config.js:
`js`
/* @type {import('playland/types/cli').UserConfig} /
module.exports = {
vite(config) {},
}
Optional index.html:
`html
$3
Add npm scripts to
package.json:`js
{
...
"scripts": {
"start": "playland start",
"build": "playland build"
}
}
``