Skip to content

Commit cbc1bac

Browse files
committed
docs: set up vitepress
1 parent 1c5a089 commit cbc1bac

15 files changed

+2316
-2
lines changed

docs/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.vitepress/dist
2+
.vitepress/cache

docs/.vitepress/config.mts

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
import {defineConfig} from 'vitepress';
2+
import { createRequire } from 'node:module'
3+
4+
const require = createRequire(import.meta.url)
5+
6+
export default defineConfig({
7+
title: 'Viselect',
8+
base: '/viselect/',
9+
description: 'Viselect - A high performance and lightweight library to add a visual way of selecting elements, just like on your Desktop. Zero dependencies, super small.',
10+
head: [
11+
['link', {rel: 'icon', href: 'favicon.png'}]
12+
],
13+
themeConfig: {
14+
nav: [
15+
{text: 'Home', link: '/'},
16+
{text: 'FAQ', link: '/pages/faq'},
17+
{text: 'API Reference', link: 'pages/api-reference'},
18+
],
19+
sidebar: [
20+
{
21+
text: 'Introduction',
22+
items: [
23+
{text: 'Quickstart', link: 'pages/quickstart'},
24+
{text: 'API Reference', link: 'pages/api-reference'},
25+
{text: 'Custom Integration', link: 'pages/custom-integration'},
26+
]
27+
},
28+
{
29+
text: 'Frameworks',
30+
items: [
31+
{text: 'Vanilla', link: 'pages/frameworks/vanilla'},
32+
{text: 'React', link: 'pages/frameworks/react'},
33+
{text: 'Preact', link: 'pages/frameworks/preact'},
34+
{text: 'Vue', link: 'pages/frameworks/vue'}
35+
]
36+
}
37+
],
38+
socialLinks: [
39+
{icon: 'github', link: 'https://github.com/simonwep/viselect'}
40+
],
41+
footer: {
42+
message: 'Released under the MIT License.',
43+
copyright: 'Copyright © 2018-present Simon Reinisch'
44+
}
45+
},
46+
vite: {
47+
resolve: {
48+
alias: {
49+
'@viselect/vanilla': require.resolve('../../packages/vanilla/dist/viselect.mjs')
50+
}
51+
}
52+
}
53+
});

docs/index.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
layout: home
3+
4+
hero:
5+
name: "Viselect"
6+
text: "Visual Selection Library"
7+
tagline: "A modern, ultra-tiny, and highly optimized selection library"
8+
image:
9+
src: logo.png
10+
alt: Viselect logo
11+
actions:
12+
- theme: brand
13+
text: Quickstart
14+
link: pages/quickstart
15+
- theme: alt
16+
text: API Reference
17+
link: pages/api-reference
18+
19+
features:
20+
- icon: 🌟
21+
title: Modern Bundle
22+
details: A cutting-edge bundle for modern web development, ensuring compatibility with the latest standards and practices.
23+
- icon: 🔩
24+
title: Ultra Tiny
25+
details: Extremely lightweight, around 4kb in size, making it perfect for performance-critical applications.
26+
- icon: 👌
27+
title: Simple Usage
28+
details: Easy to use with minimal setup required, allowing developers to integrate it quickly into their projects.
29+
- icon:
30+
title: Highly Optimized
31+
details: Performance-focused and highly efficient, designed to handle large datasets and complex operations smoothly.
32+
- icon: 🚀
33+
title: Zero Dependencies
34+
details: No external dependencies required, reducing the risk of conflicts and simplifying the build process.
35+
- icon: 📱
36+
title: Mobile / Touch Support
37+
details: Fully compatible with mobile and touch devices, providing a seamless experience across all platforms.
38+
- icon: 🖱
39+
title: Scroll Support
40+
details: Supports both vertical and horizontal scrolling, ensuring smooth navigation and interaction.
41+
- icon: 💪
42+
title: Proven Stability
43+
details: Over 3 years of development and widely used in many applications, demonstrating its reliability and robustness.
44+
- icon: 🖼
45+
title: Framework Support
46+
details: Compatible with major frameworks (work in progress), making it versatile and easy to integrate with various technologies.
47+
---
48+

0 commit comments

Comments
 (0)