@neato/guider
v1.1.0
Published
Beautiful documentation sites, without all the hassle
Downloads
14
Maintainers
Readme
⚡@neato/guider
Beautiful documentation sites, without all the hassle. Check out the documentation
🔥Features
- Beautiful default theme.
- Use React components inside your markdown, through MDX.
- Run as many documentation sites as you want with just one deployment.
- Based on NextJS, so not restricted to just documentation.
- Customize every part of the layout, possible on a per page basis.
🍄Installation / usage
**Visit the documentation on how to install.
📖Documentation
**Visit the website for documentation.
🧬 Running locally for development
npm i -g pnpm # install PNPM if you don't have it already
pnpm i # install dependencies of the entire repo
pnpm -C packages/guider run dev # run library dev script in directory
pnpm -C apps/docs run dev # run documentation site dev script in directory