Skip to content

Commit

Permalink
[core] Add packages description to README
Browse files Browse the repository at this point in the history
  • Loading branch information
@rtivital
rtivital committed Oct 7, 2021
1 parent 068d722 commit 92eb446
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
14 changes: 14 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,20 @@ Mantine is a MIT licensed open source react components and hooks library with fo
- [Follow on Twitter](https://twitter.com/mantinedev)
- [Join Discord community](https://discord.gg/eUZpPbpxb4)

## Packages

- [`@mantine/hooks`](https://mantine.dev/hooks/getting-started/) – collection of 30+ hooks for state and UI management
- [`@mantine/styles`](https://mantine.dev/theming/create-styles/) – [emotion](https://emotion.sh/) based css-in-js library that is used in all Mantine components
- [`@mantine/core`](https://mantine.dev/core/getting-started/) – core components library – 100+ components, exports everything from `@mantine/styles`
- [`@mantine/notifications`](https://mantine.dev/others/notifications/) – a fully featured notifications system
- [`@mantine/prism`](https://mantine.dev/others/prism/) – code highlight built with [prism-react-renderer](https://github.com/FormidableLabs/prism-react-renderer)
- [`@mantine/rte`](https://mantine.dev/others/rte/) – a Quill based rich text editor
- [`@mantine/dropzone`](https://mantine.dev/others/dropzone/) – manages files drag 'n' drop to area or entire screen
- [`@mantine/ssr`](https://mantine.dev/theming/ssr/) – server side rendering utilities
- [`@mantine/next`](https://mantine.dev/theming/next/) – server side rendering utilities for Next.js
- [`gatsby-plugin-mantine`](https://mantine.dev/theming/gatsby/) – Gatsby plugin to setup server side rendering
- `@mantine/eslint-config` – ESLint and Prettier configuration that is used in all Mantine project

## Contributors

<a href="https://github.com/mantinedev/mantine/graphs/contributors">
Expand Down
5 changes: 3 additions & 2 deletions docs/src/docs/pages/basics.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,13 @@ Mantine has a very friendly community, we are always happy to help you get start

## Mantine packages

- `@mantine/hooks` – collection of [30+ react hooks](/hooks/getting-started/)
- `@mantine/styles` – [emotion](https://emotion.sh/) based css-in-js library that is used in all Mantine component, usually this package is installed automatically and exported from `@mantine/core` – there is no need to install it separately, [learn more about createStyles](/theming/create-styles/)
- `@mantine/hooks` – collection of [30+ react hooks](/hooks/getting-started/) for state and UI management
- `@mantine/styles` – [emotion](https://emotion.sh/) based css-in-js library that is used in all Mantine components, usually this package is installed automatically and exported from `@mantine/core` – there is no need to install it separately, [learn more about createStyles](/theming/create-styles/)
- `@mantine/core` – core components library – 100+ components, exports everything from `@mantine/styles`
- `@mantine/notifications` – a fully featured [notifications system](/others/notifications/)
- `@mantine/prism` – [code highlight](/others/prism/) built with [prism-react-renderer](https://github.com/FormidableLabs/prism-react-renderer)
- `@mantine/rte` – a Quill based [rich text editor](/others/rte/)
- `@mantine/dropzone` – manages [files drag 'n' drop](/others/dropzone/) to area or entire screen
- `@mantine/ssr` – [server side rendering](/theming/ssr/) utilities
- `@mantine/next` – components and ssr utils for [Next.js integration](/theming/next/)
- `gatsby-plugin-mantine` – [Gatsby plugin](/theming/gatsby/) to setup ssr
Expand Down

0 comments on commit 92eb446

Please sign in to comment.