Creole Laravel Package

Product Decisions This Supports

• Internal Documentation & Knowledge Base: Accelerate launch of a company wiki or internal documentation portal by leveraging a lightweight, PHP-native wiki parser (avoiding proprietary tools like Confluence).
• Developer Experience (DX) Improvements: Enable Markdown-like syntax for technical documentation (e.g., API specs, runbooks) while retaining wiki features (e.g., tables of contents, cross-page links).
• Build vs. Buy: Justify open-source adoption over custom development for a wiki parser, reducing long-term maintenance costs (MIT license aligns with most orgs’ policies).
• Roadmap Prioritization: Phase 1: Replace static docs with dynamic wiki pages; Phase 2: Integrate with Laravel’s Blade templates for seamless embedding in apps.
• Use Cases:
  • Onboarding portals for employees/partners.
  • Customer-facing knowledge bases (if combined with a frontend like Livewire).
  • Internal runbooks for DevOps/SRE teams (supports code blocks, syntax highlighting via Markdown).

When to Consider This Package

• Adopt if:

  • Your stack is Laravel/PHP and you need a lightweight wiki parser with Markdown extensibility (e.g., adding custom wiki syntax like {{toc}}).
  • You prioritize self-hosted solutions over SaaS (avoids vendor lock-in).
  • Your team has PHP expertise to customize/extend the parser (e.g., adding plugins for analytics or versioning).
  • You’re building a low-traffic wiki (14 GitHub stars suggest niche adoption; monitor performance at scale).

• Look elsewhere if:

  • You need real-time collaboration (consider DokuWiki or a headless CMS like Strapi).
  • Your audience requires rich media embedding (videos, iframes) beyond Markdown (evaluate alternatives like CommonMark or custom solutions).
  • You lack PHP resources to integrate/maintain the parser (e.g., in a Python/JS-heavy org).
  • Compliance requires enterprise-grade support (MIT license lacks vendor backing).

How to Pitch It (Stakeholders)

For Executives: "Creole offers a cost-effective way to modernize our documentation with wiki features—think Confluence but self-hosted and developer-friendly. It integrates natively with Laravel, reducing toolchain complexity. For ~$0 (MIT license), we get a foundation to launch an internal wiki in weeks, not months, while keeping data control in-house. Ideal for scaling onboarding or technical docs without SaaS subscriptions."

For Engineering: "This is a drop-in Markdown parser with wiki extensions (tables of contents, cross-links) for PHP. Perfect if we’re already using Laravel and want to avoid bloated CMS setups. Example use: Parse {{toc}} in Markdown files to auto-generate nav bars. Low risk—MIT licensed, active enough for basic needs (14 stars), and extensible for custom syntax. Tradeoff: No built-in user management (we’d need to pair with Laravel Auth)."