Creole Full Bundle Laravel Package

Product Decisions This Supports

• Internal Documentation & Wiki Systems: Enables lightweight, markdown-like wiki functionality for internal documentation, knowledge bases, or collaborative notes without requiring a full-fledged wiki solution (e.g., MediaWiki, Confluence).
• Build vs. Buy: Avoids reinventing a custom markdown parser or integrating third-party SaaS tools (e.g., GitHub Wiki, Notion) for internal use cases. Reduces dependency on external services.
• Developer-Friendly Content: Supports structured, version-controlled documentation (e.g., README.md-style content) with minimal overhead. Ideal for teams using Git for documentation.
• Roadmap for Self-Service Tools: Foundation for future features like:
  • Embedded wiki pages in Symfony apps (e.g., admin dashboards, help centers).
  • Integration with existing CMS or content workflows.
  • Custom syntax extensions (e.g., tables, diagrams) via Creole’s parser.
• Legacy System Modernization: Upgrades older PHP/Symfony apps with wiki capabilities without major refactoring (Symfony 2.3+ compatibility).

When to Consider This Package

• Avoid if:
  • You need real-time collaboration (e.g., Google Docs-style editing). Creole is static; use a dedicated wiki tool (e.g., DokuWiki, Tiki Wiki).
  • Your team requires advanced markdown features (e.g., GFM tables, emoji). Consider Parsedown or CommonMark.
  • You’re using Symfony 3.0+: The bundle targets Symfony 2.3, risking compatibility issues. Evaluate alternatives like knplabs/knp-markdown-bundle.
  • You need user authentication/permissions. This is a parser only; pair with Symfony’s security layer or a dedicated wiki solution.
  • Performance is critical: Creole’s parser may not match optimized alternatives (e.g., Michelf/Markdown).
• Consider if:
  • You’re locked into Symfony 2.3+ and need a simple, self-hosted wiki parser.
  • Your use case is internal, low-traffic documentation (e.g., API docs, runbooks).
  • You want to leverage existing Creole syntax (e.g., {{include}}, {{toc}}) for structured content.

How to Pitch It (Stakeholders)

For Executives:

"This package lets us build a lightweight, self-hosted wiki for internal docs—like a simplified version of Confluence—without vendor lock-in. It’s a drop-in solution for Symfony apps, reducing reliance on third-party tools (e.g., GitHub Wiki) and keeping documentation version-controlled alongside code. Low maintenance, open-source, and MIT-licensed. Ideal for teams already using Symfony 2.3+."

Business Case:

• Cost: Free (MIT license), no SaaS subscriptions.
• Risk: Minimal (parser-only; integrates with existing Symfony security).
• ROI: Faster onboarding for docs, reduced tool sprawl.

For Engineering:

*"This wraps softark/creole, a Creole/WikiText parser, into a Symfony bundle. Key benefits:

• Quick integration: Composer install + bundle registration.
• Creole syntax: Supports wiki tables, includes, and TOCs out of the box (unlike basic markdown).
• Symfony-native: Works with Twig templates, security, and caching layers.
• Extensible: Hook into Creole’s parser for custom syntax (e.g., {{diagram}} macros).

Trade-offs:

• Symfony 2.3 only (may need polyfills for newer versions).
• No built-in UI—pair with a simple frontend (e.g., CKEditor with Creole plugin) or existing Symfony templates.

Proposal: Use this for:

1. Internal docs: Replace static README.md files with editable wiki pages.
2. Admin panels: Embed help text or guides in Symfony apps.
3. Legacy upgrades: Add wiki features to older Symfony 2 apps without rewrites.

Alternatives:

• For modern Symfony: knp-markdown-bundle (better markdown support).
• For full wikis: Self-host DokuWiki or use GitBook."*