{"id":37068014,"url":"https://github.com/makercorn/git-wiki-builder","last_synced_at":"2026-01-14T07:59:40.168Z","repository":{"id":300698709,"uuid":"1006854497","full_name":"MakerCorn/git-wiki-builder","owner":"MakerCorn","description":"AI Generated Wiki Builder Tool","archived":false,"fork":false,"pushed_at":"2025-07-03T07:20:04.000Z","size":284,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-12T03:04:59.664Z","etag":null,"topics":["ai","automation","generator","github","github-actions","wiki"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MakerCorn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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}},"created_at":"2025-06-23T05:14:25.000Z","updated_at":"2025-07-03T07:20:06.000Z","dependencies_parsed_at":"2025-06-23T06:37:41.223Z","dependency_job_id":null,"html_url":"https://github.com/MakerCorn/git-wiki-builder","commit_stats":null,"previous_names":["makercorn/git-wiki-builder"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/MakerCorn/git-wiki-builder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MakerCorn%2Fgit-wiki-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MakerCorn%2Fgit-wiki-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MakerCorn%2Fgit-wiki-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MakerCorn%2Fgit-wiki-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MakerCorn","download_url":"https://codeload.github.com/MakerCorn/git-wiki-builder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MakerCorn%2Fgit-wiki-builder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28413527,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T05:26:33.345Z","status":"ssl_error","status_checked_at":"2026-01-14T05:21:57.251Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["ai","automation","generator","github","github-actions","wiki"],"created_at":"2026-01-14T07:59:39.360Z","updated_at":"2026-01-14T07:59:40.154Z","avatar_url":"https://github.com/MakerCorn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Git Wiki Builder\n\n**AI-powered GitHub Wiki generator that automatically creates comprehensive documentation for your projects.**\n\n[![PyPI version](https://badge.fury.io/py/git-wiki-builder.svg)](https://badge.fury.io/py/git-wiki-builder)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)\n\n## 🌟 Overview\n\nGit Wiki Builder transforms your project's README, documentation files, and code structure into a comprehensive, well-organized GitHub Wiki using AI. It analyzes your project intelligently and generates professional documentation that follows industry best practices.\n\n### ✨ Key Benefits\n\n- **🤖 AI-Powered**: Uses GitHub's hosted AI models (free for public repos) to generate high-quality content\n- **🚀 Zero Configuration**: Works out-of-the-box with sensible defaults\n- **⚡ Automated**: Integrates seamlessly with GitHub Actions for continuous documentation\n- **📚 Comprehensive**: Creates complete wiki structure with multiple sections\n- **🎯 Intelligent**: Analyzes your project to detect APIs, Docker, tests, and more\n- **✅ Quality Assured**: Built-in markdown validation and auto-fixing\n- **🔧 Customizable**: Flexible prompts and configuration options\n- **💰 Cost-Effective**: Uses free GitHub Models for public repositories\n\n### 🏗️ What It Creates\n\nGit Wiki Builder automatically generates a complete wiki structure:\n\n- **🏠 Home**: Project overview and navigation\n- **🚀 Getting Started**: Installation, configuration, first steps  \n- **📖 User Guide**: Features, usage examples, tutorials\n- **🔌 API Reference**: Endpoint documentation (if APIs detected)\n- **👩‍💻 Development**: Contributing guidelines, setup, testing\n- **🚢 Deployment**: Deployment guides and best practices\n- **❓ FAQ**: Common questions and troubleshooting\n- **📝 Changelog**: Release notes and migration guides\n\n## 🚀 Quick Start\n\n### 1. Install Git Wiki Builder\n\n```bash\npip install git-wiki-builder\n```\n\n### 2. One-Command Setup\n\nRun this in your repository root to set up everything automatically:\n\n```bash\ncurl -sSL https://raw.githubusercontent.com/example/git-wiki-builder/main/setup-wiki.sh | bash\n```\n\nOr manually create the workflow file:\n\n```bash\nmkdir -p .github/workflows\n```\n\nCreate `.github/workflows/wiki.yml`:\n\n```yaml\nname: Generate Wiki Documentation\n\non:\n  push:\n    branches: [main, master]\n    paths: ['README.md', 'docs/**', 'src/**', '*.md']\n  workflow_dispatch:\n\npermissions:\n  contents: read\n  pages: write\n  id-token: write\n\njobs:\n  generate-wiki:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n        with:\n          fetch-depth: 0\n      - uses: actions/setup-python@v4\n        with:\n          python-version: '3.11'\n      - run: pip install git-wiki-builder\n      - run: git-wiki-builder\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          GITHUB_REPOSITORY: ${{ github.repository }}\n```\n\n### 3. Enable Wiki \u0026 Push\n\n1. **Enable Wiki in your repository**:\n   - Go to Settings → Features → Wikis ✓\n\n2. **Commit and push**:\n   ```bash\n   git add .github/workflows/wiki.yml\n   git commit -m \"Add automated wiki generation\"\n   git push\n   ```\n\n3. **Your wiki is ready!** 🎉\n   - Visit `https://github.com/yourusername/yourrepo/wiki`\n   - Wiki updates automatically when you modify README.md, docs/, or source code\n\n## 🎯 Why Git Wiki Builder?\n\n### Traditional Documentation Problems\n- ❌ Manual wiki creation is time-consuming\n- ❌ Documentation gets outdated quickly  \n- ❌ Inconsistent structure across projects\n- ❌ Requires dedicated technical writers\n- ❌ Hard to maintain comprehensive coverage\n\n### Git Wiki Builder Solutions\n- ✅ **Automated Generation**: AI creates content from your existing files\n- ✅ **Always Up-to-Date**: Regenerates on every code change\n- ✅ **Consistent Structure**: Professional, standardized wiki layout\n- ✅ **Developer-Friendly**: Works with your existing workflow\n- ✅ **Comprehensive Coverage**: Analyzes entire project structure\n\n### Perfect For\n\n- 🔧 **Open Source Projects**: Professional documentation attracts contributors\n- 🏢 **Enterprise Teams**: Consistent documentation across all repositories  \n- 📚 **API Projects**: Automatic API documentation generation\n- 🚀 **Startups**: Professional appearance without dedicated resources\n- 👨‍🎓 **Learning Projects**: Well-documented code for portfolios\n\n## 🛠️ Advanced Usage\n\n### Local Testing\n\n```bash\n# Test locally before publishing\ngit-wiki-builder --dry-run --output-dir ./wiki-preview\n\n# Use verbose logging for debugging\ngit-wiki-builder --verbose --dry-run\n```\n\n### Custom Configuration\n\nCreate `.git-wiki-builder.yml`:\n\n```yaml\n# AI Configuration\nai:\n  provider: \"github\"      # Free for public repos\n  model: \"gpt-4o-mini\"    # Fast and efficient\n\n# Custom Wiki Structure\nwiki_structure:\n  \"Home\": [\"overview\", \"quick_start\"]\n  \"Documentation\": [\"user_guide\", \"api_docs\"]\n  \"Development\": [\"contributing\", \"setup\"]\n\n# Validation\nvalidation:\n  skip: false  # Enable markdown validation\n```\n\n### Alternative AI Providers\n\n```yaml\n# Use OpenAI (requires API key)\nai:\n  provider: \"openai\"\n  model: \"gpt-4\"\n\n# Use Anthropic Claude (requires API key)  \nai:\n  provider: \"anthropic\"\n  model: \"claude-3-sonnet-20240229\"\n```\n\n### Custom Prompts\n\nCreate `custom-prompts.yml`:\n\n```yaml\nhome: |\n  Create a welcoming home page for {project_name}.\n  Highlight: {key_features}\n  Make it beginner-friendly and engaging.\n\napi_reference: |\n  Document the API for {project_name}.\n  Include authentication, endpoints, and examples.\n  Code structure: {code_structure}\n```\n\nUse with: `git-wiki-builder --prompt-file custom-prompts.yml`\n\n## 📊 Supported Project Types\n\nGit Wiki Builder works with **any project** but provides enhanced support for:\n\n| Technology | Auto-Detected Features |\n|------------|------------------------|\n| **Python** | Dependencies, virtual envs, testing frameworks |\n| **Node.js** | Package.json, npm scripts, testing |\n| **Docker** | Container deployment, compose files |\n| **APIs** | OpenAPI specs, endpoint documentation |\n| **CI/CD** | GitHub Actions, deployment pipelines |\n| **Databases** | Schema documentation, migrations |\n\n## 🔧 Command Line Options\n\n```bash\ngit-wiki-builder [OPTIONS]\n\nOptions:\n  -r, --repo-path DIRECTORY    Repository path (default: current directory)\n  -c, --config-file FILE       Custom configuration file\n  -p, --prompt-file FILE       Custom prompt templates\n  -o, --output-dir DIRECTORY   Local output directory\n  --ai-provider [github|openai|anthropic]  AI provider (default: github)\n  --ai-model TEXT              Specific model to use\n  --dry-run                    Generate locally without publishing\n  --verbose                    Enable detailed logging\n  --skip-validation            Skip markdown validation\n  --help                       Show help message\n```\n\n## 🌍 Environment Variables\n\n| Variable | Description | Required |\n|----------|-------------|----------|\n| `GITHUB_TOKEN` | GitHub token (auto-provided in Actions) | Yes |\n| `GITHUB_REPOSITORY` | Repository name (auto-provided in Actions) | Yes |\n| `OPENAI_API_KEY` | OpenAI API key | Only for OpenAI provider |\n| `ANTHROPIC_API_KEY` | Anthropic API key | Only for Anthropic provider |\n\n## 🔍 How It Works\n\n1. **📖 Analysis**: Scans README, docs/, and source code\n2. **🧠 AI Generation**: Uses AI to create comprehensive content\n3. **✅ Validation**: Validates and fixes markdown formatting\n4. **📤 Publishing**: Commits to GitHub Wiki repository\n5. **🔄 Automation**: Repeats on every relevant change\n\n## 🤝 Contributing\n\nWe welcome contributions! See our [Contributing Guide](CONTRIBUTING.md) for details.\n\n### Development Setup\n\n```bash\ngit clone https://github.com/example/git-wiki-builder.git\ncd git-wiki-builder\npip install -e \".[dev]\"\npytest\n```\n\n## 📄 License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n## 🆘 Support \u0026 Resources\n\n- 📚 [Documentation Wiki](https://github.com/example/git-wiki-builder/wiki)\n- 🐛 [Report Issues](https://github.com/example/git-wiki-builder/issues)\n- 💬 [GitHub Discussions](https://github.com/example/git-wiki-builder/discussions)\n- 📧 [Email Support](mailto:support@example.com)\n\n## 🌟 Examples\n\nSee Git Wiki Builder in action:\n- [Example Python Project](https://github.com/example/python-project/wiki)\n- [Example Node.js API](https://github.com/example/nodejs-api/wiki)  \n- [Example Docker App](https://github.com/example/docker-app/wiki)\n\n---\n\n**⭐ Star this repository if Git Wiki Builder helps your project!**\n\nMade with ❤️ for the developer community\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmakercorn%2Fgit-wiki-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmakercorn%2Fgit-wiki-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmakercorn%2Fgit-wiki-builder/lists"}