Markdown Builder Laravel Package

Product Decisions This Supports

• Feature: Markdown export / "download as Markdown" — Adds a low-effort export path for reports, dashboards, changelogs, knowledge-base articles, and generated docs. Useful when users want portable, version-controllable output rather than PDF or HTML.
• Roadmap: documentation and content pipelines — Supports scoping work on generated READMEs, release notes, API summaries, or internal runbooks assembled from application data.
• Build vs. buy: buy (cheaply) and vendor — At 23 stars and a 2021 last release, this is not a strategic dependency. Treat it as a reference implementation or vendored utility, not a platform commitment. A fluent Markdown builder is ~200–400 lines; a senior engineer can replicate the subset you need in a day, which usually beats inheriting an unmaintained dependency.
• Use cases where it fits: internal tooling, admin-only export buttons, CI scripts that emit Markdown artifacts, LLM/context assembly where Markdown is the interchange format, and developer-facing CLIs.
• Use cases where it does not fit: customer-facing rendering (pair with a real parser/renderer like league/commonmark), anything requiring sanitization guarantees, or long-lived public APIs.
• Decision it should not drive: do not let a "generate Markdown" requirement pull in a Markdown rendering dependency decision. Building and rendering are separate concerns; keep them separate in the spec.

When to Consider This Package

Adopt only if all of the following hold:

• You need to emit Markdown programmatically from PHP/Laravel (headings, lists, tables, links, code blocks) and want a fluent API rather than string concatenation or Blade templates.
• The output is consumed by developers, internal tools, or downstream parsers — not rendered directly to untrusted end users.
• You can accept the maintenance profile: last release 2021-10-23, 23 stars, single maintainer, no visible security posture. Pin the version, audit the source (it is small), and be prepared to fork.
• Your PHP/Laravel version is compatible; verify against your framework version rather than assuming.
• MIT license is acceptable (it is) and attribution/vendoring fits your policy.

Look elsewhere (or build in-house) when:

• You need rendering, sanitization, or CommonMark compliance — use league/commonmark for parsing/rendering and keep generation separate.
• You already template content with Blade — a resources/views/exports/report.blade.md is often simpler, testable, and zero-dependency.
• You need active maintenance, security patches, or vendor support — this package will not provide them.
• The requirement is one-off formatting — a small private helper class is lower total cost than a dependency review, SCA onboarding, and future upgrade work.

How to Pitch It (Stakeholders)

To executives: This is a small, free (MIT) utility that lets us add "export as Markdown" to internal reports and generated documentation with minimal engineering time. It is not a strategic platform bet: the library is small, thinly maintained (last release 2021), and we should cap our exposure by pinning it or, preferably, vendoring the handful of functions we actually use. Expected cost is low single-digit engineering days including review; the upside is faster delivery of a frequently requested export format.

To engineering: Treat it as a convenience API over string building, not infrastructure. Audit the source before merge (it is small enough to read in one sitting), pin the version, wrap it behind our own MarkdownExporter interface so it can be swapped for Blade templates or an in-house builder without touching call sites, and add golden-file tests on the output. Do not use it for rendering or sanitization — pair any customer-facing path with league/commonmark. If the wrapper takes more than a day, drop the dependency and write the builder ourselves; the API surface we need is narrow.