mirror of
https://github.com/Litlyx/litlyx
synced 2025-12-10 07:48:37 +01:00
docs adjustments
This commit is contained in:
@@ -1 +0,0 @@
|
||||
# Website
|
||||
@@ -4,8 +4,7 @@ sidebar_position: 2
|
||||
|
||||
# Create your first project
|
||||
|
||||
|
||||
After the signup, create your first project 🔥
|
||||
You just sign in! Now it's time to create your first project 🔥
|
||||
**just inserting a name for it**
|
||||
|
||||
|
||||
|
||||
@@ -3,10 +3,12 @@ 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! ⏱️**
|
||||
Installing and integrating LitLyx into your code is simpler than anything else you've tried so far.
|
||||
|
||||
**To install LitLyx, run the following command:**
|
||||
|
||||
You can use `yarn`, `npm`, `pnpm`, `bun`. We use npm because is the more simple.
|
||||
|
||||
```bash
|
||||
npm i litlyx
|
||||
```
|
||||
@@ -19,7 +21,7 @@ import TabItem from '@theme/TabItem';
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="js" label="JavaScript" default>
|
||||
**(reading javascript)**
|
||||
(reading javascript)
|
||||
|
||||
```ts
|
||||
//import
|
||||
@@ -34,7 +36,7 @@ If your are using vanilla js you can find pretty intresting this approach too
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="vue" label="Vue" default>
|
||||
**(reading Vue)**
|
||||
(reading Vue)
|
||||
|
||||
```ts
|
||||
//import
|
||||
@@ -43,7 +45,7 @@ import { Lit } from 'litlyx';
|
||||
#
|
||||
</TabItem>
|
||||
<TabItem value="react" label="React" default>
|
||||
**(reading React)**
|
||||
(reading React)
|
||||
|
||||
|
||||
```ts
|
||||
@@ -53,7 +55,7 @@ import { Lit } from 'litlyx';
|
||||
#
|
||||
</TabItem>
|
||||
<TabItem value="next" label="Next" default>
|
||||
**(reading Next)**
|
||||
(reading Next)
|
||||
|
||||
|
||||
```ts
|
||||
@@ -63,7 +65,7 @@ import { Lit } from 'litlyx';
|
||||
#
|
||||
</TabItem>
|
||||
<TabItem value="nuxt" label="Nuxt" default>
|
||||
**(reading Nuxt)**
|
||||
(reading Nuxt)
|
||||
|
||||
|
||||
```ts
|
||||
@@ -74,7 +76,7 @@ import { Lit } from 'litlyx';
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="angular" label="Angular" default>
|
||||
**(reading Angular)**
|
||||
(reading Angular)
|
||||
|
||||
|
||||
```ts
|
||||
|
||||
@@ -5,12 +5,12 @@ sidebar_position: 1
|
||||
# Signup
|
||||
|
||||
To start using LitLyx to the maximum potential you need an account on our dashboard 🔥
|
||||
**quick 1-min Setup⏱️**
|
||||
**Less than 1-min Setup⏱️**
|
||||
|
||||
|
||||
**LitLyx dashboard is super easy** you can start navigate here **[dashboard.litlyx.com](https://dashboard.litlyx.com)**.
|
||||
**LitLyx dashboard is super user friendly**. **[sign in here](https://dashboard.litlyx.com)**.
|
||||
|
||||
In this page below 👇 just click on "Continue with google". Semplicity is key ✨.
|
||||
You will find this page below 👇 just click on "Continue with google". Simple.
|
||||
|
||||
<img src="/img/l.jpg" alt="Login on Dashboard" width="600"/>
|
||||
|
||||
@@ -2,22 +2,24 @@
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Welcome to LitLyx
|
||||
# Ehy 👋 Welcome to LitLyx
|
||||
|
||||
Discover ultra-fast, real-time analytics with LitLyx 🔥 **Read time: 1 minute ⏱️** Developers, let's dive in!
|
||||
This docs aim to be concise and simple to follow in order to setup quickly and easy Litlyx in your project. **Is just 1 minute read-time. ⏱️** Let's dive in!
|
||||
|
||||
## What is LitLyx?
|
||||
|
||||
LitLyx integrates real-time analytics and custom events into any project using just a single line of code. Compatible with over 15 JavaScript/TypeScript frameworks, it is designed for developers but accessible to all, from designers to investors, to enrich projects with essential KPIs.
|
||||
LitLyx brings real-time analytics and custom events to any JS/TS project with just a single line of code. Enhance your projects with +10 KPIs effortlessly. Enjoy AI-powered dashboards for intuitive data insights, automatic reports sent straight to your email, and seamless CSV file downloads to work on your data.
|
||||
|
||||
|
||||
## Integrating LitLyx
|
||||
|
||||
Integrating LitLyx is straightforward ✨. Follow this simple code to add LitLyx to your project quickly:
|
||||
Integrating LitLyx is simple. Follow this simple code to add Litlyx to your project quickly:
|
||||
|
||||
### Quick Integration Guide
|
||||
## Quick Integration Guide
|
||||
|
||||
---
|
||||
|
||||
#### Universal Insertion
|
||||
### Universal Insertion
|
||||
Place this line in your project (recommended below the body tag in index.html):
|
||||
|
||||
|
||||
@@ -25,12 +27,16 @@ Place this line in your project (recommended below the body tag in index.html):
|
||||
<script defer data-project="project_id_here" src="https://cdn.jsdelivr.net/npm/litlyx@1.1.0/browser/litlyx.js"></script>
|
||||
```
|
||||
|
||||
This script collects various data from your websites, including `page visits`, `referrers`, `page routes`, `operating systems (OS)`, `browsers`, `countries`, `unique users`, `average session times`, and `real-time user access`. All data is gathered and displayed in real-time in your Litlyx dashboard.
|
||||
|
||||
#### Framework-Specific Steps (e.g., Nuxt.js, Next.js)
|
||||
---
|
||||
|
||||
1. **Access the Dashboard**: Visit 👉 [dashboard](https://dashboard.litlyx.com) and sign in.
|
||||
### Framework-Specific Steps (e.g., Nuxt.js, Next.js, Vue, Angular, React)
|
||||
|
||||
1. **Sign in**: Visit 👉 [sign in page](https://dashboard.litlyx.com).
|
||||
2. **Create Your First Project**: Simply enter a name for your project to get started.
|
||||
3. **Setup LitLyx**: Use the following commands to install and initialize LitLyx 👇
|
||||
3. **Copy your project_id**: Copy the project id from the dashboard.
|
||||
4. **Setup LitLyx**: Use the following commands to install and initialize LitLyx 👇
|
||||
|
||||
```bash
|
||||
npm i litlyx
|
||||
@@ -46,15 +52,18 @@ import { Lit } from 'litlyx';
|
||||
Lit.init('project_id');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
||||
## Why Choose LitLyx?
|
||||
|
||||
With LitLyx, you gain several advantages:
|
||||
Litlyx have transparency at his core. We are `Open-Source`, so you can inspect our code, in his entirety and see what happen behind the scene.
|
||||
|
||||
- **Efficiency**: Setup in less than a minute.
|
||||
- **Real-Time Data**: Real-time feedback on user interactions & website performance.
|
||||
- **Scalability**: Built to handle from small projects to large-scale applications.
|
||||
### Our clients love it for this stuffs👇
|
||||
|
||||
- **Fast**: Setup in less than a minute.
|
||||
- **Real-Time**: Real-time feedback on user interactions & website performance.
|
||||
- **Lightweight**: less than 4 KB lib size.
|
||||
- **User-Friendly**: Designed with simplicity in mind.
|
||||
- **Zero-waste**: Designed to be less than 4 KB.
|
||||
- **Open-source**: LitLyx is Open-Source.
|
||||
|
||||
### Enhance your website or app with LitLyx today! 🔥
|
||||
|
||||
@@ -48,16 +48,17 @@ const config: Config = {
|
||||
label: 'Docs',
|
||||
},
|
||||
{
|
||||
href: 'https://github.com/botkalista/litlyx-javascript-lib',
|
||||
label: 'GitHub',
|
||||
href: 'https://github.com/Litlyx/litlyx',
|
||||
label: 'Github Repo',
|
||||
position: 'right',
|
||||
className: 'navbar__link navbar__link--github',
|
||||
},
|
||||
],
|
||||
},
|
||||
footer: {
|
||||
style: 'light',
|
||||
links: [],
|
||||
copyright: `Copyright © ${new Date().getFullYear()} LitLyx, All rights reserved. Made with ❤️ in Italy.`,
|
||||
copyright: `© ${new Date().getFullYear()} Litlyx | All rights reserved.`,
|
||||
},
|
||||
prism: {
|
||||
theme: prismThemes.github,
|
||||
|
||||
@@ -28,3 +28,18 @@
|
||||
--ifm-color-primary-lightest: #84c0ff;
|
||||
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
|
||||
}
|
||||
|
||||
|
||||
/* Targeting the GitHub link button */
|
||||
.navbar__link--github {
|
||||
background-color: #333;
|
||||
color: #fff;
|
||||
padding: 10px;
|
||||
border-radius: 5px;
|
||||
transition: background-color 0.3s ease, color 0.3s ease;
|
||||
}
|
||||
|
||||
.navbar__link--github:hover {
|
||||
background-color: #555;
|
||||
color: #ddd;
|
||||
}
|
||||
@@ -3,8 +3,9 @@
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
height: 20rem;
|
||||
height: 40rem;
|
||||
text-align: center;
|
||||
background: radial-gradient(rgb(1, 1, 77), black);
|
||||
}
|
||||
|
||||
.hero img {
|
||||
|
||||
@@ -13,10 +13,11 @@ function MainHeader() {
|
||||
<header className={clsx('hero', styles.hero)}>
|
||||
<img src="/img/logo.png" alt="Logo" />
|
||||
<h1 className="hero-title">Welcome to LitLyx Docs</h1>
|
||||
<h3 className="hero-title">One-Line Code Lightweight Analytics | AI Powered Analytics Dashboard</h3>
|
||||
<Link
|
||||
className="button button--secondary button--lg"
|
||||
to="/intro">
|
||||
Read Docs 🔥 | 3 min read ⏱️
|
||||
Go To Docs | 1 Min Read
|
||||
</Link>
|
||||
</header>
|
||||
);
|
||||
@@ -29,7 +30,6 @@ export default function Home(): JSX.Element {
|
||||
description="LitLyx offers ultra-fast, real-time analytics and custom events with just one line of code. It seamlessly integrates with over 15 JavaScript/TypeScript frameworks. Designed for developers, it's also accessible to everyone from designers to investors, enhancing your projects with valuable insights.
|
||||
">
|
||||
<MainHeader />
|
||||
<HomepageFeatures />
|
||||
</Layout>
|
||||
);
|
||||
}
|
||||
|
||||
BIN
docs/static/img/dchart.jpg
vendored
BIN
docs/static/img/dchart.jpg
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 244 KiB After Width: | Height: | Size: 144 KiB |
BIN
docs/static/img/dtop.jpg
vendored
BIN
docs/static/img/dtop.jpg
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 255 KiB |
BIN
docs/static/img/l.jpg
vendored
BIN
docs/static/img/l.jpg
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 153 KiB After Width: | Height: | Size: 1.5 MiB |
BIN
docs/static/img/rep.jpg
vendored
BIN
docs/static/img/rep.jpg
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 141 KiB |
Reference in New Issue
Block a user