mirror of
https://github.com/Litlyx/litlyx
synced 2025-12-11 16:28:37 +01:00
add docs
This commit is contained in:
Emily
8
docs/docs/getstarted/_category_.json
Normal file
8
docs/docs/getstarted/_category_.json
Normal file
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Get Started",
|
||||
"position": 9,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "5 minutes to learn the most important Docusaurus concepts."
|
||||
}
|
||||
}
|
||||
17
docs/docs/getstarted/congrats.md
Normal file
17
docs/docs/getstarted/congrats.md
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
# Congratulations!
|
||||
|
||||
You've successfully completed your LitLyx setup! 🔥 **Now, explore page visits, custom events, and KPIs directly on your dashboard.**.
|
||||
|
||||
**Visit the Dashboard:** Access it [here](http://dashboard.litlyx.com)
|
||||
|
||||
|
||||
<img src="/img/dchart.jpg" alt="Dashboard Chart" width="600"/>
|
||||
|
||||
### We're Eager to Hear from You!
|
||||
|
||||
Enjoy LitLyx! 🔥
|
||||
|
||||
23
docs/docs/getstarted/create_project.md
Normal file
23
docs/docs/getstarted/create_project.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Create your first project
|
||||
|
||||
|
||||
After the signup, create your first project 🔥
|
||||
**just inserting a name for it**
|
||||
|
||||
|
||||
|
||||
**Choose a name for your first project!** is just that easy!
|
||||
|
||||
<img src="/img/first.jpg" alt="Login on Dashboard" width="600"/>
|
||||
|
||||
##
|
||||
|
||||
:::info
|
||||
|
||||
You can change your name, delete, or upgrade `an individual project` always.
|
||||
|
||||
:::
|
||||
140
docs/docs/getstarted/events.md
Normal file
140
docs/docs/getstarted/events.md
Normal file
@@ -0,0 +1,140 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Custom Events
|
||||
Your are not satisfied with the incredible insights you can gain from just one line of code? Looking for more control over your user interactions? LitLyx has you covered there too. 🔥 **Setup a custom event!**
|
||||
## Choose your Framework
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="js" label="JavaScript" default>
|
||||
|
||||
**(reading JavaScript)**
|
||||
|
||||
```ts
|
||||
//trigger the event, record it real-time on dashboard
|
||||
Lit.event('pretty_cool_event');
|
||||
```
|
||||
Still craving more control? Wow, you really are a dedicated developer! 🌟
|
||||
|
||||
```ts
|
||||
Lit.event('pretty_cool_event',
|
||||
metadata: {
|
||||
'tag': 'litlyx so lit, dude1',
|
||||
'age': 28,
|
||||
'score': 99.99,
|
||||
'litlist': ['Hello', 'Lit']
|
||||
}
|
||||
);
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem value="vue" label="Vue" default>
|
||||
|
||||
**(reading Vue)**
|
||||
|
||||
```ts
|
||||
//trigger the event, record it real-time on dashboard
|
||||
Lit.event('pretty_cool_event');
|
||||
```
|
||||
Still craving more control? Wow, you really are a dedicated developer! 🌟
|
||||
|
||||
```ts
|
||||
Lit.event('pretty_cool_event',
|
||||
metadata: {
|
||||
'tag': 'litlyx so lit, dude1',
|
||||
'age': 28,
|
||||
'score': 99.99,
|
||||
'litlist': ['Hello', 'Lit']
|
||||
}
|
||||
);
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem value="react" label="React" default>
|
||||
|
||||
**(reading React)**
|
||||
|
||||
```ts
|
||||
//trigger the event, record it real-time on dashboard
|
||||
Lit.event('pretty_cool_event');
|
||||
```
|
||||
Still craving more control? Wow, you really are a dedicated developer! 🌟
|
||||
|
||||
```ts
|
||||
Lit.event('pretty_cool_event',
|
||||
metadata: {
|
||||
'tag': 'litlyx so lit, dude1',
|
||||
'age': 28,
|
||||
'score': 99.99,
|
||||
'litlist': ['Hello', 'Lit']
|
||||
}
|
||||
);
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem value="next" label="Next" default>
|
||||
|
||||
**(reading Next)**
|
||||
|
||||
|
||||
```ts
|
||||
//trigger the event, record it real-time on dashboard
|
||||
Lit.event('pretty_cool_event');
|
||||
```
|
||||
Still craving more control? Wow, you really are a dedicated developer! 🌟
|
||||
|
||||
```ts
|
||||
Lit.event('pretty_cool_event',
|
||||
metadata: {
|
||||
'tag': 'litlyx so lit, dude1',
|
||||
'age': 28,
|
||||
'score': 99.99,
|
||||
'litlist': ['Hello', 'Lit']
|
||||
}
|
||||
);
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem value="nuxt" label="Nuxt" default>
|
||||
|
||||
**(reading Nuxt)**
|
||||
|
||||
```ts
|
||||
//trigger the event, record it real-time on dashboard
|
||||
Lit.event('pretty_cool_event');
|
||||
```
|
||||
Still craving more control? Wow, you really are a dedicated developer! 🌟
|
||||
|
||||
```ts
|
||||
Lit.event('pretty_cool_event',
|
||||
metadata: {
|
||||
'tag': 'litlyx so lit, dude1',
|
||||
'age': 28,
|
||||
'score': 99.99,
|
||||
'litlist': ['Hello', 'Lit']
|
||||
}
|
||||
);
|
||||
```
|
||||
</TabItem>
|
||||
<TabItem value="angular" label="Angular" default>
|
||||
|
||||
**(reading Angular)**
|
||||
|
||||
```ts
|
||||
//trigger the event, record it real-time on dashboard
|
||||
Lit.event('pretty_cool_event');
|
||||
```
|
||||
Still craving more control? Wow, you really are a dedicated developer! 🌟
|
||||
|
||||
```ts
|
||||
Lit.event('pretty_cool_event',
|
||||
metadata: {
|
||||
'tag': 'litlyx so lit, dude1',
|
||||
'age': 28,
|
||||
'score': 99.99,
|
||||
'litlist': ['Hello', 'Lit']
|
||||
}
|
||||
);
|
||||
```
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
86
docs/docs/getstarted/import.md
Normal file
86
docs/docs/getstarted/import.md
Normal file
@@ -0,0 +1,86 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Install & Import LitLyx
|
||||
Installing and integrating LitLyx into your code is simpler than anything else you've tried so far. 🔥 **with just 1 min setup! ⏱️**
|
||||
|
||||
**To install LitLyx, run the following command:**
|
||||
|
||||
```bash
|
||||
npm i litlyx
|
||||
```
|
||||
|
||||
## Choose your Framework
|
||||
We designed LitLyx with simplicity in mind, so you can accomplish any task with just a single line of code. Now, it's time to start coding! 👇
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="js" label="JavaScript" default>
|
||||
**(reading javascript)**
|
||||
|
||||
```ts
|
||||
//import
|
||||
import { Lit } from 'litlyx';
|
||||
```
|
||||
|
||||
If your are using vanilla js you can find pretty intresting this approach too
|
||||
|
||||
```html
|
||||
<script defer data-project="project_id_here" src="https://cdn.jsdelivr.net/npm/litlyx@1.1.0/browser/litlyx.js"></script>
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="vue" label="Vue" default>
|
||||
**(reading Vue)**
|
||||
|
||||
```ts
|
||||
//import
|
||||
import { Lit } from 'litlyx';
|
||||
```
|
||||
#
|
||||
</TabItem>
|
||||
<TabItem value="react" label="React" default>
|
||||
**(reading React)**
|
||||
|
||||
|
||||
```ts
|
||||
//import
|
||||
import { Lit } from 'litlyx';
|
||||
```
|
||||
#
|
||||
</TabItem>
|
||||
<TabItem value="next" label="Next" default>
|
||||
**(reading Next)**
|
||||
|
||||
|
||||
```ts
|
||||
//import
|
||||
import { Lit } from 'litlyx';
|
||||
```
|
||||
#
|
||||
</TabItem>
|
||||
<TabItem value="nuxt" label="Nuxt" default>
|
||||
**(reading Nuxt)**
|
||||
|
||||
|
||||
```ts
|
||||
//import
|
||||
import { Lit } from 'litlyx';
|
||||
```
|
||||
#
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="angular" label="Angular" default>
|
||||
**(reading Angular)**
|
||||
|
||||
|
||||
```ts
|
||||
//import
|
||||
import { Lit } from 'litlyx';
|
||||
```
|
||||
#
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
65
docs/docs/getstarted/initialize.md
Normal file
65
docs/docs/getstarted/initialize.md
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Initialize LitLyx
|
||||
|
||||
We Installed & Imported LitLyx, now it is time to initialize everything
|
||||
|
||||
## Choose your Framework
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="js" label="JavaScript" default>
|
||||
**(reading JavaScript)**
|
||||
|
||||
```ts
|
||||
no code needed
|
||||
```
|
||||
#
|
||||
</TabItem>
|
||||
<TabItem value="vue" label="Vue" default>
|
||||
**(reading Vue)**
|
||||
|
||||
```ts
|
||||
Lit.init('project_id');
|
||||
```
|
||||
|
||||
#
|
||||
</TabItem>
|
||||
<TabItem value="react" label="React" default>
|
||||
**(reading React)**
|
||||
|
||||
```ts
|
||||
Lit.init('project_id');
|
||||
```
|
||||
#
|
||||
</TabItem>
|
||||
<TabItem value="next" label="Next" default>
|
||||
**(reading Next)**
|
||||
|
||||
```ts
|
||||
Lit.init('project_id');
|
||||
```
|
||||
#
|
||||
</TabItem>
|
||||
<TabItem value="nuxt" label="Nuxt" default>
|
||||
**(reading Nuxt)**
|
||||
|
||||
```ts
|
||||
Lit.init('project_id');
|
||||
```
|
||||
#
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="angular" label="Angular" default>
|
||||
**(reading Angular)**
|
||||
|
||||
```ts
|
||||
Lit.init('project_id');
|
||||
```
|
||||
#
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
23
docs/docs/getstarted/register.md
Normal file
23
docs/docs/getstarted/register.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Signup
|
||||
|
||||
To start using LitLyx to the maximum potential you need an account on our dashboard 🔥
|
||||
**quick 1-min Setup⏱️**
|
||||
|
||||
|
||||
**LitLyx dashboard is super easy** you can start navigate here **[dashboard.litlyx.com](https://dashboard.litlyx.com)**.
|
||||
|
||||
In this page below 👇 just click on "Continue with google". Semplicity is key ✨.
|
||||
|
||||
<img src="/img/l.jpg" alt="Login on Dashboard" width="600"/>
|
||||
|
||||
##
|
||||
|
||||
:::info
|
||||
|
||||
If the account does not exist, it will `automatically create one` for you.
|
||||
|
||||
:::
|
||||
Reference in New Issue
Block a user