{"id":51032752,"url":"https://github.com/offbit-ai/reflow","last_synced_at":"2026-06-22T02:02:17.783Z","repository":{"id":311012447,"uuid":"957423254","full_name":"offbit-ai/reflow","owner":"offbit-ai","description":"Actor-based DAG workflow execution engine for low-code applications","archived":false,"fork":false,"pushed_at":"2026-06-20T14:56:20.000Z","size":32241,"stargazers_count":17,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-06-20T15:11:55.769Z","etag":null,"topics":["automation","dag","data-flow","flow","flowbased","low-code","no-code","workflow"],"latest_commit_sha":null,"homepage":"https://offbit-ai.github.io/reflow/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/offbit-ai.png","metadata":{"files":{"readme":"README-MDBOOK.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":"2025-03-30T10:38:43.000Z","updated_at":"2026-06-20T14:56:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"610f8ce7-6973-4783-bb94-518afd675be4","html_url":"https://github.com/offbit-ai/reflow","commit_stats":null,"previous_names":["darmie/reflow"],"tags_count":46,"template":false,"template_full_name":null,"purl":"pkg:github/offbit-ai/reflow","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offbit-ai%2Freflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offbit-ai%2Freflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offbit-ai%2Freflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offbit-ai%2Freflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/offbit-ai","download_url":"https://codeload.github.com/offbit-ai/reflow/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offbit-ai%2Freflow/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34630770,"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-22T02:00:06.391Z","response_time":106,"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":["automation","dag","data-flow","flow","flowbased","low-code","no-code","workflow"],"created_at":"2026-06-22T02:02:17.156Z","updated_at":"2026-06-22T02:02:17.770Z","avatar_url":"https://github.com/offbit-ai.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Reflow Documentation - mdBook Setup\n\nThis directory contains the complete mdBook setup for the Reflow documentation, providing a beautiful, searchable, and navigable online documentation experience.\n\n## 📚 What's Included\n\n- **Complete mdBook Configuration** (`book.toml`)\n- **Structured Navigation** (`docs/SUMMARY.md`)\n- **Custom Theme** with Reflow branding\n- **Enhanced Features** including code copying, keyboard shortcuts, and responsive design\n- **All Documentation** organized into logical sections\n\n## 🚀 Quick Start\n\n### Prerequisites\n\nInstall mdBook and useful plugins:\n\n```bash\n# Install mdBook\ncargo install mdbook\n\n# Install useful plugins (optional but recommended)\ncargo install mdbook-toc\ncargo install mdbook-admonish\ncargo install mdbook-mermaid\n```\n\n### Building the Documentation\n\n```bash\n# Build the book\nmdbook build\n\n# Serve locally with live reload\nmdbook serve\n\n# Serve on a specific port\nmdbook serve --port 8080\n\n# Build and open in browser\nmdbook serve --open\n```\n\nThe documentation will be available at `http://localhost:3000` by default.\n\n## 📖 Book Structure\n\n```\n📁 Reflow Documentation\n├── 🏠 Introduction\n├── 🚀 Getting Started\n│   ├── Installation\n│   ├── Basic Concepts\n│   ├── Development Setup\n│   └── Your First Workflow\n├── 🏗️ Architecture\n│   ├── Overview\n│   ├── Actor Model\n│   ├── Message Passing\n│   └── Graph System\n├── 📋 API Documentation\n│   ├── Working with Actors\n│   └── Graph API\n│       ├── Creation\n│       ├── Analysis\n│       ├── Layout\n│       └── Advanced Features\n├── 🧩 Components \u0026 Scripting\n│   ├── Standard Library\n│   └── JavaScript \u0026 Deno Runtime\n├── 📚 Tutorials\n│   ├── Building a Visual Editor\n│   ├── ReactFlow Integration\n│   └── Performance Optimization\n├── 🚀 Deployment\n│   └── Native Deployment\n├── 💡 Examples\n│   └── Example Projects\n├── 📖 Reference\n│   ├── API Reference\n│   └── Troubleshooting Guide\n└── 📋 Appendices\n    ├── Glossary\n    └── Contributing\n```\n\n## 🎨 Custom Features\n\n### Enhanced User Experience\n- **🎨 Custom Reflow Theme** with brand colors and professional styling\n- **⌨️ Keyboard Shortcuts** for navigation and search\n- **📋 Code Copy Buttons** on all code blocks\n- **📊 Reading Progress Bar** to track documentation progress\n- **🔍 Enhanced Search** with improved highlighting\n- **📱 Responsive Design** for mobile and desktop\n\n### Keyboard Shortcuts\n- `Ctrl+S` - Focus search bar\n- `H` - Toggle sidebar\n- `T` - Toggle theme (light/dark)\n- `←/→` - Navigate between pages\n- `⌨️` icon (top right) - Show all shortcuts\n\n### Code Features\n- **Syntax Highlighting** for Rust, JavaScript, TypeScript, JSON, TOML, etc.\n- **Copy to Clipboard** buttons on all code blocks\n- **Line Numbers** for better code reference\n- **Responsive Code Blocks** that work on mobile\n\n## 🛠️ Customization\n\n### Modifying the Theme\n\nEdit the custom theme files:\n- `docs/theme/custom.css` - Custom styling and colors\n- `docs/theme/custom.js` - Interactive features and enhancements\n\n### Adding New Sections\n\n1. Create new markdown files in the `docs/` directory\n2. Update `docs/SUMMARY.md` to include the new sections\n3. Rebuild the book with `mdbook build`\n\n### Configuration\n\nModify `book.toml` to:\n- Change book metadata (title, authors, description)\n- Configure output options\n- Enable/disable preprocessors\n- Customize build settings\n\n## 📦 Deployment Options\n\n### GitHub Pages\n\n1. **Enable GitHub Pages** in repository settings\n2. **Set source** to GitHub Actions\n3. **Create workflow** (`.github/workflows/mdbook.yml`):\n\n```yaml\nname: Deploy mdBook\non:\n  push:\n    branches: [ main ]\n    paths: [ 'docs/**' ]\n\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v3\n    - name: Setup mdBook\n      uses: peaceiris/actions-mdbook@v1\n      with:\n        mdbook-version: 'latest'\n    - run: mdbook build\n    - name: Deploy\n      uses: peaceiris/actions-gh-pages@v3\n      with:\n        github_token: ${{ secrets.GITHUB_TOKEN }}\n        publish_dir: ./book\n```\n\n### Netlify\n\n1. Connect your repository to Netlify\n2. Set build command: `mdbook build`\n3. Set publish directory: `book`\n\n### Custom Domain\n\nUpdate `book.toml`:\n```toml\n[output.html]\ncname = \"docs.yourdomain.com\"\n```\n\n## 🔧 Development\n\n### File Structure\n```\n├── book.toml              # mdBook configuration\n├── docs/                  # Source documentation\n│   ├── SUMMARY.md         # Table of contents\n│   ├── README.md          # Introduction page\n│   ├── theme/             # Custom theme assets\n│   ├── getting-started/   # Getting started guides\n│   ├── architecture/      # Architecture documentation\n│   ├── api/              # API documentation\n│   ├── tutorials/        # Tutorials and guides\n│   ├── reference/        # Reference materials\n│   └── appendices/       # Glossary, contributing, etc.\n└── book/                 # Generated output (gitignored)\n```\n\n### Adding New Content\n\n1. **Create markdown files** in appropriate subdirectories\n2. **Update SUMMARY.md** to include new pages in navigation\n3. **Use relative links** for cross-references\n4. **Test locally** with `mdbook serve`\n\n### Best Practices\n\n- **Use descriptive headings** for better navigation\n- **Include code examples** where relevant\n- **Add cross-references** between related sections\n- **Test all code examples** to ensure they work\n- **Keep pages focused** on specific topics\n- **Use consistent formatting** throughout\n\n## 🎯 Features Comparison\n\n| Feature | Standard mdBook | Reflow mdBook |\n|---------|----------------|---------------|\n| Basic Documentation | ✅ | ✅ |\n| Search | ✅ | ✅ Enhanced |\n| Themes | ✅ Basic | ✅ Custom Reflow |\n| Code Highlighting | ✅ | ✅ |\n| Code Copying | ❌ | ✅ |\n| Keyboard Shortcuts | ❌ | ✅ |\n| Progress Tracking | ❌ | ✅ |\n| Mobile Responsive | ✅ Basic | ✅ Enhanced |\n| Print Support | ✅ | ✅ |\n\n## 🤝 Contributing\n\nTo contribute to the documentation:\n\n1. **Edit markdown files** in the `docs/` directory\n2. **Follow the style guide** in `docs/appendices/contributing.md`\n3. **Test locally** with `mdbook serve`\n4. **Submit a pull request** with your changes\n\n## 📞 Support\n\n- **Documentation Issues**: Create an issue in the repository\n- **mdBook Help**: Visit [mdBook documentation](https://rust-lang.github.io/mdBook/)\n- **Community**: Join our Discord for real-time help\n\n---\n\n**Happy documenting! 📚✨**\n\nThe Reflow documentation is now ready to provide an exceptional reading experience for your users.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foffbit-ai%2Freflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foffbit-ai%2Freflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foffbit-ai%2Freflow/lists"}