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 ↗