# slimdown

**Repository Path**: wfdaj/slimdown

## Basic Information

- **Project Name**: slimdown
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-24
- **Last Updated**: 2026-07-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Slimdown

![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/jbroadway/slimdown/ci.yml?branch=master)
![GitHub License](https://img.shields.io/github/license/jbroadway/slimdown)
![Packagist Version](https://img.shields.io/packagist/v/jbroadway/slimdown)
![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/jbroadway/slimdown)

A simple regex-based Markdown parser in PHP. Supports the
following elements (and can be extended via `Slimdown::add_rule()`):

* Headers
* Links
* Bold
* Emphasis
* Deletions
* Quotes
* Code blocks
* Inline code
* Blockquotes
* Ordered/unordered lists
* Checklists
* Images

Originally hosted as a [gist here](https://gist.github.com/jbroadway/2836900).

## Usage

Here is the general use case:

```php
<?php

require_once ('Slimdown.php');

echo Slimdown::render (
	"# Page title\n\nAnd **now** for something _completely_ different."
);
```

Or via [composer](https://getcomposer.org/):

```
composer require jbroadway/slimdown
```

Then:

```php
<?php

require __DIR__ . '/vendor/autoload.php';

echo Slimdown::render (
	"# Page title\n\nAnd **now** for something _completely_ different."
);
```

### Adding rules

A simple rule to convert `:)` to an image:

```php
<?php

Slimdown::add_rule ('/(\W)\:\)(\W)/', '\1<img src="smiley.png" />\2');

echo Slimdown::render ('Know what I\'m sayin? :)');
```

In this example, we add GitHub-style internal linking
(e.g., `[[Another Page]]`).

```php
<?php

function mywiki_internal_link ($title) {
	return sprintf (
		'<a href="%s">%s</a>',
		preg_replace ('/[^a-zA-Z0-9_-]+/', '-', $title),
		$title
	);
}

Slimdown::add_rule ('/\[\[(.*?)\]\]/e', 'mywiki_internal_link (\'\\1\')');

echo Slimdown::render ('Check [[This Page]] out!');
```

### A longer example

```php
<?php

echo Slimdown::render ("# Title

And *now* [a link](http://www.google.com) to **follow** and [another](http://yahoo.com/).

* One
* Two
* Three

## Subhead

One **two** three **four** five.

One __two__ three _four_ five __six__ seven _eight_.

1. One
2. Two
3. Three

More text with `inline($code)` sample.

> A block quote
> across two lines.

- [ ] One
- [x] Two
- [ ] Three

More text...");
```