dart_doc_pilot 1.0.4
dart_doc_pilot: ^1.0.4 copied to clipboard
A powerful Flutter project documentation generator with rich UI and CLI experience
Changelog #
1.0.3 - 2024-12-04 #
1.0.0 - 2024-12-02 #
Added #
- 🎉 Initial release of dart_doc_pilot
- 📚 Comprehensive documentation extraction for Dart/Flutter projects
- 🎨 Beautiful HTML documentation generator with Material Design 3
- 📝 Markdown documentation export
- 🔧 JSON export for custom integrations
- 💎 Impressive CLI with ASCII banner and loading animations
- 🔍 Support for all Dart constructs:
- Classes (with inheritance, mixins, interfaces)
- Methods (including getters, setters, async)
- Fields (with all modifiers)
- Constructors (default, named, const, factory)
- Enums (with value documentation)
- Extensions
- Typedefs
- Parameters (with full type information)
- 📖 Full Flutter documentation syntax support:
{@category}and{@subCategory}tags{@template}and{@macro}for reusable content- Code blocks with syntax highlighting
- Cross-references with
[ClassName]
- 🌐 Local documentation server with live reload
- 🔎 Live search functionality in HTML output
- 📂 Category-based navigation
- 🎯 Breadcrumb navigation
- ✨ Smooth animations and transitions
- 📱 Responsive design for all screen sizes
- 📊 Detailed statistics and timing information
- 🎭 Colored terminal output with emoji icons
Documentation #
- Comprehensive README with examples
- Example Dart files demonstrating documentation features
- CLI command reference
- API usage guide
Performance #
- Optimized AST parsing using Dart analyzer
- Efficient file scanning with path exclusions
- Fast HTML generation with templating
[Unreleased] #
Planned Features #
- Custom themes for HTML output
- PDF export support
- Dark/light mode toggle in UI
- Search result highlighting
- API versioning support
- Class diagram generation
- Multi-language support
- IDE plugins (VS Code, IntelliJ)
- Watch mode for automatic regeneration
- Documentation coverage reports
- Custom template support
- Annotation-based configuration