README

A markdown renderer component for Laravel applications. Converts markdown text to styled HTML. Works with Livewire and Vue 3.

Installation

composer require mrshanebarron/markdown

Livewire Usage

Basic Usage

<livewire:sb-markdown :content="$markdownContent" />

With Custom Styling

<livewire:sb-markdown
    :content="$article"
    prose-class="prose-lg prose-blue"
/>

Livewire Props

Vue 3 Usage

Setup

import { SbMarkdown } from './vendor/sb-markdown';
app.component('SbMarkdown', SbMarkdown);

Basic Usage

<template>
  <SbMarkdown :content="markdown" />
</template>

<script setup>
const markdown = `
# Hello World

This is **bold** and *italic* text.

## Lists

- Item one
- Item two
- Item three

## Code

\`\`\`javascript
const greeting = 'Hello!';
console.log(greeting);
\`\`\`
`;
</script>

Blog Post Example

<template>
  <article class="max-w-3xl mx-auto py-8">
    <h1 class="text-4xl font-bold mb-4">{{ post.title }}</h1>
    <p class="text-gray-500 mb-8">{{ post.date }}</p>

    <SbMarkdown
      :content="post.content"
      prose-class="prose-lg"
    />
  </article>
</template>

Documentation Viewer

<template>
  <div class="flex">
    <nav class="w-64 p-4 border-r">
      <button
        v-for="doc in docs"
        :key="doc.id"
        @click="activeDoc = doc"
        class="block w-full text-left px-3 py-2 rounded hover:bg-gray-100"
      >
        {{ doc.title }}
      </button>
    </nav>

    <main class="flex-1 p-8">
      <SbMarkdown :content="activeDoc.content" />
    </main>
  </div>
</template>

Vue Props

Supported Syntax

Features

• Headers: H1, H2, H3 support
• Emphasis: Bold, italic, strikethrough
• Links: External links with noopener
• Images: Rounded image styling
• Lists: Ordered and unordered
• Code: Inline and block code
• Blockquotes: Quote styling
• Prose Styling: Tailwind Typography

Styling

Uses Tailwind CSS Typography:

• Prose base styling
• Customizable with prose modifiers
• Automatic paragraph spacing
• Code block styling
• Link styling

Requirements

• PHP 8.1+
• Laravel 10, 11, or 12
• Tailwind CSS 3.x
• @tailwindcss/typography (recommended)

License

MIT License