QuickLook Docs

April 25, 2026 ยท View on GitHub

QuickLook Logo

QuickLook Docs

Official homepage for QuickLook โ€” macOS Quick Look for Windows.


Live Site


VitePress Vue Tailwind CSS Vercel License


๐Ÿš€ Getting Started

# Install dependencies
npm install

# Start dev server
npm run docs:dev

# Build for production
npm run docs:build

# Preview production build
npm run docs:preview

๐Ÿ“ File Structure

.
โ”œโ”€โ”€ .github/
โ”‚   โ”œโ”€โ”€ ISSUE_TEMPLATE/
โ”‚   โ”‚   โ”œโ”€โ”€ bug_report.md           # Bug report template
โ”‚   โ”‚   โ”œโ”€โ”€ feature_request.md      # Feature request template
โ”‚   โ”‚   โ””โ”€โ”€ ui_improvement.md       # UI/UX improvement template
โ”‚   โ”œโ”€โ”€ workflows/
โ”‚   โ”‚   โ””โ”€โ”€ labeler.yml             # Auto-label workflow
โ”‚   โ”œโ”€โ”€ labeler.yml                 # Label rules config
โ”‚   โ””โ”€โ”€ PULL_REQUEST_TEMPLATE.md    # PR template
โ”‚
โ”œโ”€โ”€ docs/
โ”‚   โ”œโ”€โ”€ .vitepress/
โ”‚   โ”‚   โ”œโ”€โ”€ theme/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ ChangelogViewer.vue   # Fetches live changelog from GitHub
โ”‚   โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ FeatureGrid.vue       # Features overview grid
โ”‚   โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ FormatTable.vue       # Supported file formats table
โ”‚   โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ HomeHero.vue          # Homepage hero with stats & CTA
โ”‚   โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ InstallTabs.vue       # Installation method tabs
โ”‚   โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ PluginCard.vue        # Plugin gallery cards
โ”‚   โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ ShortcutRow.vue       # Keyboard shortcuts display
โ”‚   โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ StatsBanner.vue       # GitHub stars/forks stats
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ composables/
โ”‚   โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ useRelease.ts         # Fetches latest GitHub release
โ”‚   โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ useRepoStats.ts       # Fetches repo stars & forks
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ custom.css               # Custom theme styles
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ index.ts                 # Theme entry โ€” registers components
โ”‚   โ”‚   โ””โ”€โ”€ config.ts                    # VitePress site config
โ”‚   โ”‚
โ”‚   โ”œโ”€โ”€ features/
โ”‚   โ”‚   โ”œโ”€โ”€ file-support.md          # Supported file formats
โ”‚   โ”‚   โ”œโ”€โ”€ overview.md              # Features overview
โ”‚   โ”‚   โ””โ”€โ”€ plugins.md               # Plugin system & gallery
โ”‚   โ”‚
โ”‚   โ”œโ”€โ”€ guide/
โ”‚   โ”‚   โ”œโ”€โ”€ installation.md          # Installation guide
โ”‚   โ”‚   โ”œโ”€โ”€ introduction.md          # What is QuickLook?
โ”‚   โ”‚   โ””โ”€โ”€ quick-start.md           # Quick start guide
โ”‚   โ”‚
โ”‚   โ”œโ”€โ”€ resources/
โ”‚   โ”‚   โ”œโ”€โ”€ changelog.md             # Live changelog (fetched from GitHub)
โ”‚   โ”‚   โ”œโ”€โ”€ requirements.md          # System requirements
โ”‚   โ”‚   โ””โ”€โ”€ troubleshooting.md       # Common issues & fixes
โ”‚   โ”‚
โ”‚   โ”œโ”€โ”€ public/
โ”‚   โ”‚   โ”œโ”€โ”€ favicon.ico
โ”‚   โ”‚   โ”œโ”€โ”€ og-image.png
โ”‚   โ”‚   โ”œโ”€โ”€ favicon.webp
โ”‚   โ”‚   โ””โ”€โ”€ logo.webp
โ”‚   โ”‚
โ”‚   โ””โ”€โ”€ index.md                     # Homepage
โ”‚
โ”œโ”€โ”€ .gitignore
โ”œโ”€โ”€ package.json
โ””โ”€โ”€ README.md

๐Ÿ› ๏ธ Tech Stack

ToolPurpose
VitePressStatic site generator
Vue 3Component framework
Tailwind CSS v4Utility-first CSS
SoraUI font
JetBrains MonoCode font
VercelHosting & deployment

๐Ÿค Contributing

Contributions are welcome! Please use the appropriate issue template.

TypeLink
๐Ÿ› Bug reportReport a bug
๐Ÿ’ก Feature requestRequest a feature
๐ŸŽจ UI improvementSuggest a UI improvement