product.md 1.7 KB

Product Overview

GROWI is a team collaboration wiki platform using Markdown, designed to help teams document, share, and organize knowledge effectively.

Core Capabilities

  1. Hierarchical Wiki Pages: Tree-structured page organization with path-based navigation (/path/to/page)
  2. Markdown-First Editing: Rich Markdown support with extensions (drawio, lsx, math) and real-time collaborative editing
  3. Authentication Integrations: Multiple auth methods (LDAP, SAML, OAuth, Passkey) for enterprise environments
  4. Plugin System: Extensible architecture via @growi/pluginkit for custom remark plugins and functionality
  5. Multi-Service Architecture: Modular services (PDF export, Slack integration) deployed independently

Target Use Cases

  • Team Documentation: Technical documentation, meeting notes, project wikis
  • Knowledge Management: Searchable, organized information repository
  • Enterprise Deployment: Self-hosted wiki with SSO/LDAP integration
  • Developer Teams: Markdown-native, Git-friendly documentation workflow

Value Proposition

  • Open Source: MIT licensed, self-hostable, community-driven
  • Markdown Native: First-class Markdown support with powerful extensions
  • Hierarchical Organization: Intuitive path-based page structure (unlike flat wikis)
  • Enterprise Ready: Authentication integrations, access control, scalability
  • Extensible: Plugin system for customization without forking

Deployment Models

  • Self-Hosted: Docker, Kubernetes, or bare metal deployment
  • Microservices: Optional services (pdf-converter, slackbot-proxy) for enhanced functionality

Focus on patterns and purpose, not exhaustive feature lists