From 271e3dc18e786300709847c0b723fbb4a4e643dd Mon Sep 17 00:00:00 2001 From: "johancs.mm@gmail.com" Date: Sat, 13 Apr 2024 21:59:53 -0500 Subject: [PATCH] docs: add documentation component `accordion` --- docs/next.config.js | 2 +- docs/pages/docs/_meta.en-US.json | 12 +++- docs/pages/docs/accordion.en-US.mdx | 57 +++++++++++++++++++ ...arted.en-US.mdx => installation.en-US.mdx} | 4 +- ...arted.es-ES.mdx => installation.es-ES.mdx} | 0 docs/pages/docs/introduction.en-US.mdx | 57 +++++++++++++++++++ docs/pages/docs/introduction.es-ES.mdx | 57 +++++++++++++++++++ eslint.config.js | 1 + 8 files changed, 185 insertions(+), 5 deletions(-) create mode 100644 docs/pages/docs/accordion.en-US.mdx rename docs/pages/docs/{getting-started.en-US.mdx => installation.en-US.mdx} (97%) rename docs/pages/docs/{getting-started.es-ES.mdx => installation.es-ES.mdx} (100%) create mode 100644 docs/pages/docs/introduction.en-US.mdx create mode 100644 docs/pages/docs/introduction.es-ES.mdx diff --git a/docs/next.config.js b/docs/next.config.js index c4d8dd1..d49d478 100644 --- a/docs/next.config.js +++ b/docs/next.config.js @@ -17,7 +17,7 @@ module.exports = withNextra({ return [ { source: '/docs', - destination: '/docs/getting-started', + destination: '/docs/introduction', statusCode: 301, }, ] diff --git a/docs/pages/docs/_meta.en-US.json b/docs/pages/docs/_meta.en-US.json index f0e609e..63c5b62 100644 --- a/docs/pages/docs/_meta.en-US.json +++ b/docs/pages/docs/_meta.en-US.json @@ -1,3 +1,13 @@ { - "getting-started": "Getting Started" + "-- 1": { + "type": "separator", + "title": "Getting Started" + }, + "introduction": "Introduction", + "installation": "Installation", + "-- 2": { + "type": "separator", + "title": "Components" + }, + "accordion": "" } diff --git a/docs/pages/docs/accordion.en-US.mdx b/docs/pages/docs/accordion.en-US.mdx new file mode 100644 index 0000000..879f534 --- /dev/null +++ b/docs/pages/docs/accordion.en-US.mdx @@ -0,0 +1,57 @@ +--- +title: Accordion +--- +import { Accordion, AccordionItem, AccordionTrigger, AccordionContent } from '@openui-org/react/components' + +# Accordion + +A vertically stacked set of interactive headings that each reveal a section of content. + +## Usage + +```jsx +import * as React from "react"; +import { Accordion, AccordionItem, AccordionTrigger, AccordionContent } from '@openui-org/react/components' + +function App() { + return ( + + + + Use accordion? + + + Lorem ipsum dolor sit amet consectetur adipisicing elit. Explicabo, voluptatum? + + + + ); +} +``` + +### Preview + +
+ +
+ +
+ + +
+
+ + + + Use accordion? + + + Lorem ipsum dolor sit amet consectetur adipisicing elit. Explicabo, voluptatum? + + + + +
+
+
+
diff --git a/docs/pages/docs/getting-started.en-US.mdx b/docs/pages/docs/installation.en-US.mdx similarity index 97% rename from docs/pages/docs/getting-started.en-US.mdx rename to docs/pages/docs/installation.en-US.mdx index f58389a..0475a8d 100644 --- a/docs/pages/docs/getting-started.en-US.mdx +++ b/docs/pages/docs/installation.en-US.mdx @@ -1,9 +1,7 @@ import { Callout, Tabs, Tab } from 'nextra-theme-docs' import { Button } from '@openui-org/react/components' -# Getting Started - -## Installation +# Installation Requirements: diff --git a/docs/pages/docs/getting-started.es-ES.mdx b/docs/pages/docs/installation.es-ES.mdx similarity index 100% rename from docs/pages/docs/getting-started.es-ES.mdx rename to docs/pages/docs/installation.es-ES.mdx diff --git a/docs/pages/docs/introduction.en-US.mdx b/docs/pages/docs/introduction.en-US.mdx new file mode 100644 index 0000000..88fb0f5 --- /dev/null +++ b/docs/pages/docs/introduction.en-US.mdx @@ -0,0 +1,57 @@ +--- +title: Introduction +description: Open UI. OpenLand's official framework design system 🎨. +--- + +import {Accordion, AccordionItem, AccordionTrigger, AccordionContent} from '@openui-org/react/components' + +# Introduction + +Open UI. OpenLand's official framework design system. This is a non-profit library developed with existing standard concepts. + +**What is the reason for creating a new component library??** + +Thanks to existing libraries like [shadcn](https://ui.shadcn.com), it allows us the ease of creating a completely easy and customizable design system, our team wanted to take a step forward. + +## FAQ + + + + + + Who maintains Open UI? + + + Open UI is maintained by a group of friends who develop non-profit software all for educational and learning purposes in this incredible world. + + + + + + Will there be support for other popular libraries in the future? + + + Yeah. That's right, the frontend world is full of popular and excellent libraries and for us it is very important to be around those wonderful tools + + + + + + Is there an inspiration in the creation of Open UI? + + +Forks. All modern and most used libraries [nextui](https://nextui.org/), [headlessui](https://headlessui.com/), [chakra ui](https://v2.chakra-ui.com/) + + + + + + What will be the future of Open UI? + + + Open UI is a totally new library. We plan to continue maintaining the library, especially improving the quality of our components. + + + + + \ No newline at end of file diff --git a/docs/pages/docs/introduction.es-ES.mdx b/docs/pages/docs/introduction.es-ES.mdx new file mode 100644 index 0000000..88fb0f5 --- /dev/null +++ b/docs/pages/docs/introduction.es-ES.mdx @@ -0,0 +1,57 @@ +--- +title: Introduction +description: Open UI. OpenLand's official framework design system 🎨. +--- + +import {Accordion, AccordionItem, AccordionTrigger, AccordionContent} from '@openui-org/react/components' + +# Introduction + +Open UI. OpenLand's official framework design system. This is a non-profit library developed with existing standard concepts. + +**What is the reason for creating a new component library??** + +Thanks to existing libraries like [shadcn](https://ui.shadcn.com), it allows us the ease of creating a completely easy and customizable design system, our team wanted to take a step forward. + +## FAQ + + + + + + Who maintains Open UI? + + + Open UI is maintained by a group of friends who develop non-profit software all for educational and learning purposes in this incredible world. + + + + + + Will there be support for other popular libraries in the future? + + + Yeah. That's right, the frontend world is full of popular and excellent libraries and for us it is very important to be around those wonderful tools + + + + + + Is there an inspiration in the creation of Open UI? + + +Forks. All modern and most used libraries [nextui](https://nextui.org/), [headlessui](https://headlessui.com/), [chakra ui](https://v2.chakra-ui.com/) + + + + + + What will be the future of Open UI? + + + Open UI is a totally new library. We plan to continue maintaining the library, especially improving the quality of our components. + + + + + \ No newline at end of file diff --git a/eslint.config.js b/eslint.config.js index b7d6b27..5185bb2 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -2,4 +2,5 @@ import eslint from '@antfu/eslint-config' export default eslint({ formatters: true, + markdown: true, })