Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Docs

on:
workflow_dispatch:
merge_group:
push:
branches:
- main
paths:
- 'docs/**'
pull_request:
branches:
- main
paths:
- 'docs/**'

jobs:
build:
uses: yoriiis/actions/.github/workflows/test-and-build-root-demo.yml@main
with:
working-directory-demo: ./docs
4 changes: 4 additions & 0 deletions .github/workflows/e2e.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,12 @@ name: E2E Tests
on:
push:
branches: [main]
paths-ignore:
- 'docs/**'
pull_request:
branches: [main]
paths-ignore:
- 'docs/**'

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ dist
lib
test-results
playwright-report
.astro/
352 changes: 9 additions & 343 deletions README.md

Large diffs are not rendered by default.

55 changes: 55 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
// @ts-check
import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'

// https://astro.build/config
export default defineConfig({
integrations: [
starlight({
title: 'vLitejs',
description:
'Fast and lightweight JavaScript library for customizing video and audio players.',
logo: {
src: './src/assets/logo.svg',
replacesTitle: true
},
social: [
{ icon: 'github', label: 'GitHub', href: 'https://github.com/vlitejs/vlite' },
{ icon: 'npm', label: 'npm', href: 'https://www.npmjs.com/package/vlitejs' }
],
customCss: ['./src/styles/vlite.css', './src/styles/home.css'],
sidebar: [
{ label: 'Getting Started', slug: 'getting-started' },
{ label: 'Configuration', slug: 'configuration' },
{ label: 'Options', slug: 'options' },
{ label: 'Events', slug: 'events' },
{ label: 'Methods', slug: 'methods' },
{ label: 'CSS Properties', slug: 'css-properties' },
{
label: 'Providers',
items: [
{ label: 'Overview', slug: 'providers' },
{ label: 'HTML5', slug: 'providers/html5' },
{ label: 'YouTube', slug: 'providers/youtube' },
{ label: 'Vimeo', slug: 'providers/vimeo' },
{ label: 'Dailymotion', slug: 'providers/dailymotion' }
]
},
{
label: 'Plugins',
items: [
{ label: 'Overview', slug: 'plugins' },
{ label: 'Subtitle', slug: 'plugins/subtitle' },
{ label: 'Picture-in-Picture', slug: 'plugins/pip' },
{ label: 'Volume Bar', slug: 'plugins/volume-bar' },
{ label: 'Cast', slug: 'plugins/cast' },
{ label: 'AirPlay', slug: 'plugins/airplay' },
{ label: 'IMA', slug: 'plugins/ima' },
{ label: 'Sticky', slug: 'plugins/sticky' },
{ label: 'Hotkeys', slug: 'plugins/hotkeys' }
]
}
]
})
]
})
Loading
Loading