Open source documentation components

Additional work is needed to fix the CSS generated

Author: tobias-mintlify

.babelrc

@@ -0,0 +1,7 @@
+{
+  "presets": [
+    "@babel/typescript",
+    ["@babel/react", { "runtime": "automatic" }],
+    ["@babel/env", { "modules": false }]
+  ]
+}

.gitignore

@@ -0,0 +1,44 @@
+# we are using npm in this project
+yarn.lock
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+/public/feeds/
+
+# production
+/build
+/dist
+
+# generated files
+/public/*
+/src/pages/*
+!/src/pages/api
+/src/pages/api/*.mdx
+!/src/pages/*.tsx
+!/src/pages/*.ts
+/src/config.json
+/src/openapi.json
+
+# misc
+.DS_Store
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local

.npmignore

@@ -0,0 +1,10 @@
+# Storybook Tests
+/stories
+
+# Source code (we publish webpack's results not the source code itself)
+/src
+.babelrc
+webpack.config.js
+postcss.config.js
+tailwind.config.js
+tsconfig.json

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Mintlify
+Copyright (c) 2022 Mintlify, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,35 @@
-# components
-Reusable library of UI components used in Mintlify websites.
+# Mintlify Components
+
+Open-source library of UI components made with React and TailwindCSS. Checkout [Mintlify.com](https://mintlify.com/) to see the components in action.
+
+Mintlify uses Mintlify Components in customers' docs. We encourage you to use them elsewhere on your site!
+
+# Designed for Next.js
+
+The project is designed for use in 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
+
+Our [wiki](https://github.com/mintlify/components/wiki) contains most of the library's documentation.
+
+[Mintlify's documentation platform also explains how to use documentation components.](https://www.mintlify.com/components/overview)
+
+# Long Term Vision
+
+The first version of this library only included documentation components. In the long run, Mintlify will include layout components you could use to build an entire site.
+
+## Contributing
+
+All pull requests are welcome. Component files are in the `src` folder.
+
+## Community
+
+Join our Discord community if you have questions or just want to chat:
+
+[![](https://dcbadge.vercel.app/api/server/ACREKdwjG5)](https://discord.gg/ACREKdwjG5)
+
+# License
+
+[MIT](https://tldrlegal.com/license/mit-license)
+
+_Built with 💚 by the Mintlify team._