# Simple Markdown Plugin

## The Pain Point

Writing content in WordPress can be frustrating for developers and technical writers who are accustomed to Markdown. The default WordPress editor requires manual formatting through buttons and menus, which breaks the flow of writing. Existing Markdown plugins are often bloated with unnecessary features, dependencies, or complex configurations.

**Key frustrations:**
- Switching between writing and formatting modes
- Heavy plugins that slow down the editor
- Complex setup processes
- Inconsistent rendering across different themes
- Security vulnerabilities in third-party Markdown libraries

## The Thought Process

The goal was to create a **lightweight, secure, and fast** Markdown solution that integrates seamlessly with Gutenberg. The approach needed to be:

1. **Simple**: One block, one purpose
2. **Secure**: No external dependencies, proper sanitization
3. **Fast**: Custom parser optimized for common use cases
4. **Native**: Built specifically for WordPress/Gutenberg
5. **Reliable**: Predictable HTML output

## The Solution

Simple Markdown provides a custom Gutenberg block that renders Markdown content using a lightweight, purpose-built parser. It supports the most commonly used Markdown features without the bloat.

### Technical Implementation

#### Custom Markdown Parser
Instead of using external libraries like Parsedown or CommonMark, we built a custom parser that handles:

```php
// Headers (H1-H6)
if (preg_match('/^(#{1,6})\s+(.+)$/', $trimmed_line, $matches)) {
    $level = strlen($matches[1]);
    $text = $this->process_inline_markdown($matches[2]);
    $result[] = "<h{$level}>{$text}</h{$level}>";
}

// Bold and Italic
$text = preg_replace('/\*\*([^*]+)\*\*/', '<strong>$1</strong>', $text);
$text = preg_replace('/\*([^*]+)\*/', '<em>$1</em>', $text);
```

#### Gutenberg Integration
The plugin registers a custom block type with proper attributes:

```php
register_block_type('simple-markdown/markdown-block', array(
    'render_callback' => array($this, 'render_markdown_block'),
    'attributes' => array(
        'content' => array(
            'type' => 'string',
            'default' => ''
        )
    )
));
```

#### Security Features
- **ABSPATH check**: Prevents direct file access
- **Input sanitization**: All content is processed securely
- **No external dependencies**: Eliminates third-party vulnerabilities
- **Proper escaping**: HTML output is safely rendered

#### Performance Optimizations
- **Lightweight parser**: ~150 lines of PHP vs thousands in libraries
- **Footer script loading**: JavaScript loads in footer for better performance
- **Minimal dependencies**: Only uses core WordPress APIs
- **Clean HTML output**: No unnecessary wrapper elements

### Supported Markdown Features

| Feature | Syntax | Output |
|---------|--------|---------|
| Headers | `# H1` to `###### H6` | `<h1>` to `<h6>` |
| Bold | `**bold**` | `<strong>bold</strong>` |
| Italic | `*italic*` | `<em>italic</em>` |
| Code | `` `code` `` | `<code>code</code>` |
| Code Blocks | ``` \`\`\`code\`\`\` ``` | `<pre><code>code</code></pre>` |
| Links | `[text](url)` | `<a href="url">text</a>` |
| Lists | `- item` or `1. item` | `<ul><li>` or `<ol><li>` |
| Quotes | `> quote` | `<blockquote><p>quote</p></blockquote>` |

### WordPress Standards Compliance

The plugin follows all WordPress coding standards and plugin directory requirements:

- **GPLv2+ License**: Open source and compatible
- **Security First**: Proper nonces, sanitization, and validation
- **Performance**: Footer script loading, minimal footprint
- **Accessibility**: Semantic HTML output
- **Internationalization Ready**: Text domain for translations

### File Structure

```
simple-markdown/
├── simple-markdown-renderer.php  # Main plugin file
├── readme.txt                    # WordPress plugin directory readme
├── simple-markdown.md           # This documentation
└── block.js                     # Gutenberg block JavaScript (future)
```

## Why This Approach Works

1. **Focused Solution**: Solves one problem really well
2. **WordPress Native**: Built for Gutenberg from the ground up
3. **Maintainable**: Simple codebase, easy to extend
4. **Secure**: No external attack vectors
5. **Fast**: Minimal processing overhead
6. **Predictable**: Consistent output across all themes

This plugin demonstrates that sometimes the best solution is the simplest one that directly addresses the core problem without unnecessary complexity.

## Transparency Notes
Co-coded with Claude Code.