Markdown-Creator-Dart
一个功能强大的跨平台工具,使用 Flutter 构建,可轻松设计和生成专业的 README.md 文件。具备可视化拖放编辑器、AI 驱动的内容生成(Gemini)、实时预览和导出选项。立即简化您的文档工作流程!🚀
- 星标
- 2
- 复刻
- 0
- 最近推送(UTC)
- 2026年9月16日
- 项目状态
- 未归档
原始 README
以下为英文项目原文快照,最新内容请访问 GitHub。
README Creator — Flutter Documentation Workspace
Create, structure, preview, and improve GitHub README files from one cross-platform workspace.
Built with Flutter, Firebase, and optional AI-assisted writing tools.
Features
AI-assisted writing
Generate project descriptions and feature drafts with Google Gemini and use assisted editing to improve grammar and tone.
Cloud sync
Firebase integration can synchronize projects and custom snippets across supported builds.
Visual editor
Compose documentation from reusable sections and widgets, including Markdown content, diagrams, tables of contents, GitHub-oriented cards, badges, and developer-focused components.
Repository-assisted documentation
The application can use a local folder or public GitHub repository as context when preparing README content.
Cross-platform interface
The Flutter application targets web and supported desktop/mobile environments from one codebase.
Getting started
Web version
The deployed web distribution is maintained separately in Readme-Creator-Web.
Source setup
git clone https://github.com/mhmdwaelanwr/Markdown-Creator-Dart.git
cd Markdown-Creator-Dart
flutter pub get
flutter run
Tagged builds
See the repository's Releases page for published artifacts when available.
Android customization
To change the Android applicationId, set appApplicationId in gradle.properties or pass it at build time:
appApplicationId=com.example.readmecreator
./gradlew assembleRelease -PappApplicationId=com.example.readmecreator
Technology stack
- Framework: Flutter / Dart
- Cloud services: Firebase
- AI integration: Google Gemini
- State management: Provider
- Web distribution: Flutter Web / PWA assets
Repository relationship
- This repository contains the Flutter application source.
- Readme-Creator-Web contains the deployed web distribution and landing experience.
- readmecreator.studio is the public web entry point.
Contributing
Contributions, bug fixes, and documentation improvements are welcome. See CONTRIBUTING.md for the development workflow.
Security and support
License
Released under the MIT License.
分类
使用的依赖
依赖清单 49 项
- flutter
{"sdk":"flutter"} - firebase_core
^3.10.0 - firebase_auth
^5.4.0 - cloud_firestore
^5.5.0 - firebase_storage
^12.3.0 - firebase_analytics
^11.3.0 - firebase_crashlytics
^4.1.0 - firebase_messaging
^15.2.10 - google_sign_in
^6.2.1 - sign_in_with_apple
^6.1.0 - google_mobile_ads
^5.1.0 - jaspr
^0.10.0 - cupertino_icons
^1.0.8 - uuid
^4.5.2 - provider
^6.1.5+1 - shared_preferences
^2.3.2 - json_annotation
^4.9.0 - flutter_highlight
^0.7.0 - http
^1.2.0 - archive
^3.6.1 - file_picker
^8.1.7 - flutter_colorpicker
^1.1.0 - tutorial_coach_mark
^1.2.9 - markdown
^7.2.2 - printing
^5.13.2 - pdf
^3.10.10 - path_provider
^2.1.4 - share_plus
^10.1.2 - font_awesome_flutter
^10.7.0 - cached_network_image
^3.4.1 - flutter_svg
^2.0.10+1 - google_fonts
^6.2.1 - google_generative_ai
^0.4.4 - url_launcher
^6.3.0 - path
^1.9.0 - flutter_launcher_icons
^0.14.1 - flutter_native_splash
^2.4.2 - package_info_plus
^8.1.0 - desktop_drop
^0.5.0 - pasteboard
^0.3.0 - flutter_local_notifications
^18.0.1 - flutter_localizations
{"sdk":"flutter"} - intl
^0.20.2 - flutter_markdown
^0.7.3 - crypto
^3.0.3 - flutter_test开发依赖
{"sdk":"flutter"} - flutter_lints开发依赖
^5.0.0 - build_runner开发依赖
^2.4.12 - json_serializable开发依赖
^6.8.0
如何选择适合项目的代码仓?
先按使用场景筛选,再比较项目活跃情况,最后到原始仓库核对使用要求。
- 通过仓库名、作者或描述搜索,再按技术分类缩小范围。
- 结合星标、复刻与最近推送比较项目;星标反映社区关注,不代表质量保证。
- 使用前在 GitHub 核对 README、许可证与 Issues。
来源与维护
“A repository is the most basic element of GitHub.”
GitHub Docs — About repositories ↗