Skip to content

Commit

Permalink
docs: set up vitepress
Browse files Browse the repository at this point in the history
  • Loading branch information
simonwep committed Jan 18, 2025
1 parent 1c5a089 commit cbc1bac
Show file tree
Hide file tree
Showing 15 changed files with 2,316 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.vitepress/dist
.vitepress/cache
53 changes: 53 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
import {defineConfig} from 'vitepress';
import { createRequire } from 'node:module'

const require = createRequire(import.meta.url)

export default defineConfig({
title: 'Viselect',
base: '/viselect/',
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.',
head: [
['link', {rel: 'icon', href: 'favicon.png'}]
],
themeConfig: {
nav: [
{text: 'Home', link: '/'},
{text: 'FAQ', link: '/pages/faq'},
{text: 'API Reference', link: 'pages/api-reference'},
],
sidebar: [
{
text: 'Introduction',
items: [
{text: 'Quickstart', link: 'pages/quickstart'},
{text: 'API Reference', link: 'pages/api-reference'},
{text: 'Custom Integration', link: 'pages/custom-integration'},
]
},
{
text: 'Frameworks',
items: [
{text: 'Vanilla', link: 'pages/frameworks/vanilla'},
{text: 'React', link: 'pages/frameworks/react'},
{text: 'Preact', link: 'pages/frameworks/preact'},
{text: 'Vue', link: 'pages/frameworks/vue'}
]
}
],
socialLinks: [
{icon: 'github', link: 'https://github.com/simonwep/viselect'}
],
footer: {
message: 'Released under the MIT License.',
copyright: 'Copyright © 2018-present Simon Reinisch'
}
},
vite: {
resolve: {
alias: {
'@viselect/vanilla': require.resolve('../../packages/vanilla/dist/viselect.mjs')
}
}
}
});
48 changes: 48 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
layout: home

hero:
name: "Viselect"
text: "Visual Selection Library"
tagline: "A modern, ultra-tiny, and highly optimized selection library"
image:
src: logo.png
alt: Viselect logo
actions:
- theme: brand
text: Quickstart
link: pages/quickstart
- theme: alt
text: API Reference
link: pages/api-reference

features:
- icon: 🌟
title: Modern Bundle
details: A cutting-edge bundle for modern web development, ensuring compatibility with the latest standards and practices.
- icon: 🔩
title: Ultra Tiny
details: Extremely lightweight, around 4kb in size, making it perfect for performance-critical applications.
- icon: 👌
title: Simple Usage
details: Easy to use with minimal setup required, allowing developers to integrate it quickly into their projects.
- icon:
title: Highly Optimized
details: Performance-focused and highly efficient, designed to handle large datasets and complex operations smoothly.
- icon: 🚀
title: Zero Dependencies
details: No external dependencies required, reducing the risk of conflicts and simplifying the build process.
- icon: 📱
title: Mobile / Touch Support
details: Fully compatible with mobile and touch devices, providing a seamless experience across all platforms.
- icon: 🖱
title: Scroll Support
details: Supports both vertical and horizontal scrolling, ensuring smooth navigation and interaction.
- icon: 💪
title: Proven Stability
details: Over 3 years of development and widely used in many applications, demonstrating its reliability and robustness.
- icon: 🖼
title: Framework Support
details: Compatible with major frameworks (work in progress), making it versatile and easy to integrate with various technologies.
---

Loading

0 comments on commit cbc1bac

Please sign in to comment.