Socket
Socket
Sign inDemoInstall

@mintlify/components

Package Overview
Dependencies
5
Maintainers
2
Versions
99
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @mintlify/components

Open-source library of UI components made with React and TailwindCSS.


Version published
Maintainers
2
Created

Readme

Source
Mintlify Logo

Mintlify Components

Open-source library of UI components made with React and TailwindCSS.

contributions welcome Website

Built with 💚 by Mintlify


Mintlify

This repo contains the components Mintlify uses in our open-source documentation framework: mint. Checkout mintlify.com/docs to see the components in action. Feel free to use the components on your own websites!

Installation

npm install @mintlify/components

Add the following at the start of your main.css file:

@import '@mintlify/components';

Usage

Import components like so:

import { Accordion, Card } from "@mintlify/components"

Designed for Next.js

The project is designed for use with static side rendering where we don't have access to document or window. Thus, our webpack config has to use mini-css-extract-plugin instead of style-loader.

Documentation

The repo wiki explains how to contribute to the repo.

Storybook has interactive demos.

Go to mintlify.com/docs/components for how to use the components in Mintlify's documentation platform.

Long Term Vision

The first version of this library only includes documentation components. In the long run, Mintlify will include layout components you could use to build an entire site.

Community

Join our Discord community if you have questions or just want to chat:

License

MIT

Keywords

FAQs

Last updated on 07 Feb 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc