Support

What You'll Achieve

By the end of this page, you will:

• Know where to get help quickly
• Understand how to report bugs or issues
• Handle security-related issues properly
• Find the right support channel suitable for your project

Where to Get Help

If you’re using AstroAnimate and run into issues, choose the fastest path below based on your situation.

Documentation (Start here)

Before reaching out, check the docs:

• Installation guide → /docs/installation/
• Quick Start → /docs/quick-start/
• Troubleshooting → /docs/troubleshooting/

Most setup and usage issues are already covered.

Report a Bug (GitHub Issues)

If something is not working as expected:

👉 Report it on GitHub

When to use this:

• Unexpected behavior
• Errors during installation or usage
• Component not working as documented

What to include:

• Astro version
• Node.js version
• Code snippet (minimal reproduction)
• Screenshots or error logs

Example issue template:

Description→ Brief explanation of the issue

Steps to Reproduce→ Install package
→ Add component
→ Run project

Expected Behavior→ What should happen

Actual Behavior→ What actually happens

Environment→ Astro:
→ Node:
→ OS:

Report a Security Issue (IMPORTANT)

If you discover a security vulnerability or sensitive issue:

👉 Do NOT report it publicly.

Instead, follow the repository’s security policy:

• See: SECURITY.md

Why this matters:

• Prevents exposing vulnerabilities publicly
• Protects users and projects using AstroAnimate
• Ensures responsible disclosure

Do not include sensitive exploit details in public GitHub issues.

Community Support (Discord)

For quick help, discussions, or ideas:

👉 Join the Discord community

Use this for:

• Setup questions
• Best practices
• General discussion
• Feature ideas

👉 Faster than GitHub for non-critical issues

GitHub Discussions

For longer conversations and feature discussions:

👉 Use GitHub Discussions

Use this for:

• Proposing features
• Sharing use cases
• Asking conceptual questions

Common Questions

1. Why is my animation not working?

• Ensure the component is visible in the viewport
• Test with a basic component like FadeIn
• Check if styles are overridden

2. Can I use AstroAnimate with other animation libraries?

Yes. AstroAnimate can be combined with libraries like GSAP or Motion when needed.

3. Is support available for production issues?

Yes. Use GitHub Issues for reproducible bugs. Community channels can help with debugging and guidance.

Contribution & Feedback

AstroAnimate is open source. You can:

• Report bugs
• Suggest improvements
• Contribute code