Stackly Documentation

Official documentation for Stackly - an all-in-one platform for URL shortening, web scraping, PDF conversion, screenshots, team management, and task organization.

This website is built using Docusaurus, a modern static website generator.

📚 Documentation Coverage

Core Features

• Dashboard - Usage statistics and analytics overview
• URL Shortener - Custom slugs, branded domains, UTM parameters, and advanced targeting
• Branded Domains - Setup and configuration guide
• UTM Templates - Manage reusable UTM parameter sets
• Team Members - User management and role-based access control
• Stack Notes - Task management and collaborative note-taking
• Integrations - Slack and Discord notifications
• Folders - Organize links efficiently
• Web to PDF - Convert webpages to high-quality PDFs
• Digital vCards - Create and share interactive business cards

Account Management

• Profile Settings - Update profile picture and display name
• Change Password - Security settings
• Address Information - Billing address management
• Billing Information - Tax details and invoice history
• Plans & Subscriptions - Monthly/yearly plans and top-up options
• API Keys - Generate and manage API credentials
• Audit Logs - Track team activity and changes

🚀 Getting Started

Installation

npm install

Local Development

npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

🎨 Design System

The documentation uses a Dark/Futuristic theme with:

• Violet and dark gray color palette
• Inter and JetBrains Mono fonts
• Glassmorphism UI elements
• Responsive grid layouts
• Compact, modern icons

📝 Contributing

When adding new documentation pages:

1. Create a new .md file in the docs/ directory
2. Add the page to sidebars.ts
3. Follow the existing structure and formatting guidelines
4. Use GitHub-style alerts for important information
5. Include relevant screenshots in static/img/

🔗 Links

• Live Documentation: docs.stackly.in
• Main Website: stackly.in
• Application: app.stackly.in

📄 License

Copyright © 2024 Stackly. All rights reserved.