Skip to content

INDEX.md

Latest commit

 

History

History
175 lines (133 loc) · 5.48 KB

INDEX.md

File metadata and controls

175 lines (133 loc) · 5.48 KB

ScrollBox v2.0 - File Index & Navigation Guide

Welcome to the modernized ScrollBox repository! This document helps you navigate all the files.

📚 Start Here

Document Purpose Read Time
QUICK_START.md Get started in 5 minutes ⏱️ 5 min
README.md Full documentation ⏱️ 10 min
example-modern.html Live examples 🎨 Interactive

📖 Documentation

For New Users

  1. QUICK_START.md - Installation & basic usage
  2. README.md - Complete API documentation
  3. example-modern.html - Working examples

For Existing Users (Upgrading from v1)

  1. UPGRADE_SUMMARY.md - What's new in v2.0
  2. CHANGELOG.md - Detailed version history
  3. ISSUES_RESOLVED.md - Bug fixes explained

For Contributors

  1. CONTRIBUTING.md - How to contribute
  2. README.md - API reference

🔧 Source Files

Modern Version (Recommended)

Legacy Version (jQuery)

⚙️ Configuration Files

Build System

Legacy Build (Can be removed)

CI/CD

📁 Directory Structure

jquery-scrollbox/
├── 📚 Documentation
│   ├── INDEX.md                 (this file)
│   ├── README.md               (main documentation)
│   ├── QUICK_START.md          (getting started)
│   ├── CHANGELOG.md            (version history)
│   ├── UPGRADE_SUMMARY.md      (v1 → v2 guide)
│   ├── ISSUES_RESOLVED.md      (bug fixes)
│   └── CONTRIBUTING.md         (contribution guide)
│
├── 🔧 Source Code
│   ├── scrollbox.js            (modern vanilla JS)
│   ├── scrollbox.d.ts          (TypeScript definitions)
│   ├── jquery.scrollbox.js     (jQuery version)
│   └── jquery.scrollbox.min.js (minified jQuery)
│
├── 🎨 Examples
│   ├── example-modern.html     (modern examples)
│   └── demos/                  (legacy demos)
│
├── ⚙️ Configuration
│   ├── package.json            (npm config)
│   ├── rollup.config.js        (bundler)
│   ├── .babelrc               (transpiler)
│   ├── .eslintrc.json         (linter)
│   └── .github/workflows/      (CI/CD)
│
└── 📄 Legal
    └── LICENSE                 (MIT License)

🎯 Quick Access by Task

I want to...

Use ScrollBox in my project

→ Read QUICK_START.md

See working examples

→ Open example-modern.html in a browser

Learn the full API

→ Read README.md

Upgrade from v1.x

→ Read UPGRADE_SUMMARY.md

Know what bugs were fixed

→ Read ISSUES_RESOLVED.md

Contribute to the project

→ Read CONTRIBUTING.md

Use with TypeScript

→ Import scrollbox.d.ts (auto-loaded by TypeScript)

Build from source

→ Run npm install && npm run build

Understand version changes

→ Read CHANGELOG.md

🆕 What's New in v2.0?

Major Changes

  • ✅ Vanilla JavaScript (no jQuery required)
  • ✅ Modern ES6+ class syntax
  • ✅ TypeScript support
  • ✅ Modern build system (Rollup + Babel)
  • ✅ GitHub Actions CI/CD
  • ✅ Bug fixes for issues #5, #29, #37, #38

New Files

  • scrollbox.js - Modern vanilla JS version
  • scrollbox.d.ts - TypeScript definitions
  • example-modern.html - Modern examples
  • All documentation files

Updated Files

  • README.md - Completely rewritten
  • package.json - Modern dependencies

See CHANGELOG.md for complete details.

📊 File Statistics

Category Files Size
Documentation 7 ~25KB
Source Code 4 ~28KB
Configuration 5 ~3KB
Examples 2 ~15KB
Total 18 ~71KB

🔗 External Links

💡 Tips

  1. New project? Start with scrollbox.js (vanilla JS)
  2. Legacy project? Keep using jquery.scrollbox.js
  3. TypeScript? Types are automatically detected
  4. Contributing? Read CONTRIBUTING.md first
  5. Stuck? Open an issue on GitHub

📝 Version Information

  • Current Version: 2.0.0
  • Release Date: December 3, 2025
  • License: MIT
  • Author: Hunter Wu

Need help? Open an issue or read the documentation!