{"id":51026941,"url":"https://github.com/gitstq/docpolish-cli","last_synced_at":"2026-06-21T20:02:37.302Z","repository":{"id":363203207,"uuid":"1262318373","full_name":"gitstq/docpolish-cli","owner":"gitstq","description":"🦞 DocPolish - Lightweight Markdown Document Intelligent Beautification Engine | 轻量级Markdown文档智能美化引擎","archived":false,"fork":false,"pushed_at":"2026-06-07T21:13:05.000Z","size":31,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-07T23:13:15.898Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gitstq.png","metadata":{"files":{"readme":"README.en.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-06-07T21:11:37.000Z","updated_at":"2026-06-07T21:12:21.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/gitstq/docpolish-cli","commit_stats":null,"previous_names":["gitstq/docpolish-cli"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/gitstq/docpolish-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitstq%2Fdocpolish-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitstq%2Fdocpolish-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitstq%2Fdocpolish-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitstq%2Fdocpolish-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gitstq","download_url":"https://codeload.github.com/gitstq/docpolish-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitstq%2Fdocpolish-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34623906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-21T02:00:05.568Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-21T20:02:37.177Z","updated_at":"2026-06-21T20:02:37.296Z","avatar_url":"https://github.com/gitstq.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🎉 DocPolish-CLI\n\n🦞 Lightweight Markdown Document Intelligent Beautification Engine | 轻量级Markdown文档智能美化引擎\n\n## ✨ Core Features\n\n- ✨ Smart Markdown formatting\n- ✨ Document structure analysis\n- ✨ AI content polishing\n- ✨ Multi-language README generation\n- ✨ Zero-dependency core\n- 🚀 **Zero Dependencies** - Pure Python implementation, no extra dependencies needed\n- 🎨 **Smart Formatting** - Automatically fix Markdown formatting issues\n- 🤖 **AI Enhancement** - Integrated with GLM-5.1 for content polishing and translation\n- 🌍 **Multi-language Support** - One-click multi-language README generation\n- 📊 **Document Analysis** - Deep analysis of document structure and quality\n\n## 🚀 Quick Start\n\n### Requirements\n\n- Python 3.8+\n- pip\n\n### Installation\n\n```bash\npip install docpolish\n```\n\n### Basic Usage\n\n```bash\n# Format a Markdown document\ndocpolish format README.md\n\n# Analyze document structure\ndocpolish analyze document.md\n\n# AI-powered content polishing\ndocpolish polish README.md --style professional\n\n# Generate multi-language README\ndocpolish readme --project-name \"MyProject\" --lang en,zh-cn\n```\n\n## 📖 Detailed Usage Guide\n\n### Format Command\n\n```bash\n# Format and overwrite original file\ndocpolish format README.md\n\n# Format and output to new file\ndocpolish format README.md -o README_formatted.md\n\n# Check only, don't modify\ndocpolish format README.md --check\n\n# Show diff of changes\ndocpolish format README.md --diff\n```\n\n### Analyze Command\n\n```bash\n# Text format analysis\ndocpolish analyze document.md\n\n# JSON output\ndocpolish analyze document.md --json\n```\n\n### AI Polishing\n\n```bash\n# Professional style polishing\ndocpolish polish README.md --style professional\n\n# Simple style polishing\ndocpolish polish README.md --style simple\n\n# Specify API key\ndocpolish polish README.md --api-key YOUR_API_KEY\n```\n\n### Translation\n\n```bash\n# Translate to English\ndocpolish translate README.md --target en\n\n# Translate to Simplified Chinese\ndocpolish translate README.md --target zh-cn\n```\n\n### README Generator\n\n```bash\n# Generate multi-language README\ndocpolish readme --project-name \"MyApp\" \\\n  --description \"A powerful tool\" \\\n  --lang en,zh-cn,zh-tw \\\n  --features \"Fast,Easy,Secure\"\n```\n\n## 💡 Design Philosophy \u0026 Roadmap\n\n### Design Philosophy\n\nDocPolish is designed to solve the formatting inconsistencies, layout chaos, and multi-language maintenance difficulties that developers face when writing and maintaining Markdown documents. Through intelligent format fixing and AI enhancement features, document writing becomes effortless and efficient.\n\n### Technical Choices\n\n- **Pure Python Implementation**: Zero-dependency core ensures cross-platform compatibility\n- **Regex Engine**: Efficient text parsing and formatting\n- **GLM-5.1 Integration**: Powerful Chinese understanding and generation capabilities\n- **Modular Architecture**: Easy to extend and maintain\n\n### Roadmap\n\n- [ ] v1.1.0 - Support more Markdown extension syntaxes (GFM, CommonMark)\n- [ ] v1.2.0 - Add real-time preview feature\n- [ ] v1.3.0 - Support custom formatting rules\n- [ ] v2.0.0 - Web UI interface\n\n## 📦 Packaging \u0026 Deployment Guide\n\n### Install from Source\n\n```bash\ngit clone https://github.com/gitstq/docpolish-cli.git\ncd docpolish-cli\npip install -e .\n```\n\n### Build Release Package\n\n```bash\npython -m build\n```\n\n### Install Local Package\n\n```bash\npip install dist/docpolish-1.0.0-py3-none-any.whl\n```\n\n## 🤝 Contributing Guide\n\nIssues and Pull Requests are welcome!\n\n### Commit Convention\n\n- `feat:` New feature\n- `fix:` Bug fix\n- `docs:` Documentation update\n- `refactor:` Code refactoring\n\n### Development Workflow\n\n1. Fork this repository\n2. Create a feature branch (`git checkout -b feat/amazing-feature`)\n3. Commit your changes (`git commit -m 'feat: add amazing feature'`)\n4. Push to the branch (`git push origin feat/amazing-feature`)\n5. Create a Pull Request\n\n## 📄 License\n\nThis project is licensed under the [MIT](LICENSE) License.\n\n---\n\n\u003cp align=\"center\"\u003eMade with ❤️ by Lobster AI\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitstq%2Fdocpolish-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitstq%2Fdocpolish-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitstq%2Fdocpolish-cli/lists"}