https://github.com/pmndrs/valtio

🧙 Valtio makes proxy-state simple for React and Vanilla
https://github.com/pmndrs/valtio

mutable proxy react state

Last synced: 4 days ago
JSON representation

🧙 Valtio makes proxy-state simple for React and Vanilla

• Host: GitHub
• URL: https://github.com/pmndrs/valtio
• Owner: pmndrs
• License: mit
• Created: 2020-11-16T22:30:51.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T07:38:57.000Z (about 2 months ago)
• Last Synced: 2024-10-30T04:50:25.852Z (about 1 month ago)
• Topics: mutable, proxy, react, state
• Language: TypeScript
• Homepage: https://valtio.dev
• Size: 4.1 MB
• Stars: 9,066
• Watchers: 39
• Forks: 252
• Open Issues: 2
• Metadata Files:
  • Readme: docs/readme.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-repos - pmndrs/valtio - 🧙 Valtio makes proxy-state simple for React and Vanilla (TypeScript)
• awesome-list - valtio - state simple for React and Vanilla | pmndrs | 2804 | (TypeScript)
• awesome-react-three-fiber - valtio
• awesome-webxr-development - Valtio - badge] - Makes proxy-state simple for React and Vanilla (State Management / Visual Editor)
• awesome-web-dev - valtio
• awesome-react-state-management - valtio - Simple proxy-state. (List)
• awesome-f2e-libs - **valtio**
• awesome-star-libs - pmndrs / valtio
• awesome-fe-resources - valtio
• my-awesome-list - valtio - state simple for React and Vanilla | pmndrs | 9175 | (TypeScript)
• awesome-javascript - valtio - state simple for React and Vanilla (Packages)
• awesome-javascript - valtio - state simple for React and Vanilla (Packages)

README

        
## How to contribute

### Basic things to know before adding docs

- Docs live in `docs/` folder.

- Website lives in `website/` folder.

- Docs are written in `mdx` format.

- Docs filename shouldn't have spaces.

- Website would generate title and other metadata from graymatter in the file.

- You should be able to render condesandbox inside `mdx` files by simply adding the url for the same

- Once you have a doc, you can add it to the sidebar section by adding it to the nav in `getDocsNav` function inside `website/lib/mdx.ts`