Skip to content

Commit

Permalink
chore: initial docs
Browse files Browse the repository at this point in the history
chore: add scripts
  • Loading branch information
chrisbbreuer committed Dec 9, 2024
1 parent 4a6c8cb commit 586d29e
Show file tree
Hide file tree
Showing 7 changed files with 940 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ lib-cov
logs
node_modules
temp
docs/.vitepress/cache
Binary file modified bun.lockb
Binary file not shown.
32 changes: 32 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import { defineConfig } from 'vitepress'

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: 'ts-collect',
description: 'A simple, fast, and secure TLS certificate manager for your projects.',
cleanUrls: true,

themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Docs', link: '/intro' },
{ text: 'Changelog', link: 'https://github.com/stacksjs/tlsx/releases' },
],

sidebar: [
{
text: 'Get Started',
items: [
{ text: 'Introduction', link: '/intro' },
{ text: 'Install', link: '/install' },
],
},
],

socialLinks: [
{ icon: 'github', link: 'https://github.com/stacksjs/ts-collect' },
{ icon: 'bluesky', link: 'https://bsky.app/profile/chrisbreuer.dev' },
{ icon: 'twitter', link: 'https://twitter.com/stacksjs' },
],
},
})
29 changes: 29 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
layout: home

hero:
name: "ts-collect"
text: "A TypeScript Collection Library"
tagline: "Powerful, yet lightweight, Laravel-like Collections written for TypeScript"
actions:
- theme: brand
text: Documentation
link: /intro
- theme: alt
text: View on GitHub
link: https://github.com/stacksjs/ts-collect

features:
- title: Familiar API
icon: 👪
details: "Laravel-like API for working with collections in TypeScript."
- title: Lightweight
icon: 🚀
details: "Small footprint and performance optimized."
- title: Powerful
icon: 💪
details: "Rich set of methods for working with collections."
- title: Fully Typed
icon: 🏗️
details: "Written in and for TypeScript, with full type support."
---
Loading

0 comments on commit 586d29e

Please sign in to comment.