Skip to content

Commit

Permalink
Merge pull request #43 from unify-ui-dev/dev
Browse files Browse the repository at this point in the history
Add markdown content files
  • Loading branch information
Johnkat-Mj authored Mar 16, 2024
2 parents fcea583 + c327408 commit 952ef8d
Show file tree
Hide file tree
Showing 109 changed files with 16,815 additions and 1,688 deletions.
59 changes: 35 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Flexilla is a set of unstyled components that help you quickly add interactivit

## Installation

1. Install all components
### Install all components

To install the library :

- Install It From Npm
1. Install It From Npm

You need to add it as a dependency in your project using npm or any other package manager

Expand All @@ -30,46 +30,38 @@ Or
yarn add @flexilla/flexilla
```

- Use CDN

You need to include the following script in your project

```html
<head>
<!-- other meta tags -->
<script src="https://unpkg.com/@flexilla/flexilla@latest/dist/flexilla.min.js"></script>
</head>
<body>

<script>
const accordion = new Flexilla.Accordion("#myAccordion");
const tabs = new Flexilla.Tabs("#my-tabs");
</script>
</body>
```
2. Use CDN

Import Module from CDN

```html
<script type="module">
import { Accordion, Tabs } from 'https://cdn.jsdelivr.net/npm/@flexilla/flexilla@latest/dist/flexilla.esm.min.js';
const accordion = new Accordion("#selector");
import * as flexilla from 'https://cdn.jsdelivr.net/npm/@flexilla/flexilla@latest/+esm';
new flexilla.Accordion("#ac-el")
</script>
```

> **Note** : You can use any available CDN Deliver
1. Install a single package
### Install a single package

If you want to use only one package or two then we recommand you to install only those packages

- let's say you need an Accordion component only
1. let's say you need an Accordion component only

```shell
npm install @flexilla/accordion
```

2. From CDN
```html
<script type="module">
import * as flexillatabs from 'https://cdn.jsdelivr.net/npm/@flexilla/tabs@latest/+esm'
new flexillatabs.Tabs("#myTabs")
</script>
```


[Check all packages](./packages/)

## Usage
Expand All @@ -80,13 +72,32 @@ See examples [Here](./examples/vanilla/)

To contribute to this project, please make sure you read our [contributing guide](CONTRIBUTING.MD) before submitting a pull request.

## ✨ Maintainers


<table>
<tr>
<td align="center" width="200"><pre><a href="https://github.com/Johnkat-Mj"><img src="https://avatars.githubusercontent.com/u/59884686?v=4" width="200" alt="Johnkat MJ Github Avatar" /><br><sub>Johnkat MJ</sub></a><br>@johnkat-mj</pre></td>
<td align="center" width="200"><pre><a href="https://github.com/Tresor-Kasenda"><img src="https://avatars.githubusercontent.com/u/34010260?v=4" width="200" alt="Tresor Kasenda Github Avatar" /><br><sub>Tresor Kasenda</sub></a><br>@tresor-kasenda</pre></td>
</tr>
</table>


## 🙌 Acknowledgement

Flexilla is made possible thanks to the inspirations from the following projects:

- <a href="https://github.com/htmlstreamofficial/preline" target="_blank">Preline Plugins</a>
- <a href="https://github.com/themesberg/flowbite" target="_blank">Flowbite Plugin</a>


## Community

Connect with us for future updates

- [Discord](https://discord.gg/6VN6zTPZAy).


## 📄 License

This project is licensed under the **MIT License** - see the [**MIT License**](LICENSE) file for details.
46 changes: 24 additions & 22 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,39 +1,41 @@
import { defineConfig } from 'astro/config';
import { defineConfig } from "astro/config";
import UnoCSS from "unocss/astro";
import preact from "@astrojs/preact";
import mdx from "@astrojs/mdx";
import { transformerNotationDiff } from 'shikiji-transformers';
import { transformerNotationDiff } from "shikiji-transformers";
import vercel from "@astrojs/vercel/serverless";
import sitemap from "@astrojs/sitemap";

import partytown from "@astrojs/partytown";

import db from "@astrojs/db";

// https://astro.build/config
export default defineConfig({
redirects: {
'/docs': {
"/docs": {
status: 302,
destination: '/docs/getting-started'
}
destination: "/docs/getting-started",
},
},
site: 'https://flexilla-docs.vercel.app',
site: "https://flexilla-docs.vercel.app",
markdown: {
shikiConfig: {
theme: "css-variables",
transformers: [transformerNotationDiff()]
}
transformers: [transformerNotationDiff()],
},
},
integrations: [UnoCSS({
injectReset: true
}), preact(), mdx(), sitemap(),
partytown(
{
integrations: [
UnoCSS({
injectReset: true,
}),
preact(),
mdx(),
partytown({
config: {
forward: ["dataLayer.push"],
},
}
)
],
forward: ["dataLayer.push"],
},
}),
db(),
],
output: "server",
adapter: vercel()
});
adapter: vercel(),
});
15 changes: 15 additions & 0 deletions docs/db/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { column, defineDb, defineTable } from 'astro:db';


const NewsLetter = defineTable({
columns: {
id: column.number({ primaryKey: true }),
email: column.text({ unique: true }),
appSubsribed: column.text()
}
})

// https://astro.build/db/config
export default defineDb({
tables: { NewsLetter }
});
6 changes: 6 additions & 0 deletions docs/db/seed.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { db } from 'astro:db';

// https://astro.build/db/seed
export default async function seed() {
// TODO
}
Loading

0 comments on commit 952ef8d

Please sign in to comment.