# mage2pro/markdown

> The «Markdown» extension for Magento 2

`composer require mage2pro/markdown`

Canonical URL: https://packagento.com/mage2pro/markdown

## At a glance

- **Vendor**: mage2pro (https://packagento.com/mage2pro.md)
- **Latest version**: 1.2.1 — released 2023-08-06
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/mage2pro/markdown and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require mage2pro/markdown:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

The «Markdown» extension for Magento 2

## README

The «[**Markdown Editor**](https://mage2.pro/c/extensions/markdown)» module for Magento 2 allows you to format the store's content (product descriptions, articles, CMS blocks and so on) with Markdown markup language.  
The standard Magento editor (TinyMCE) produces lot of HTML mess. Markdown allows you to make your content more accurate, clean, professionally looked.  
The module is **free** and **open source**.

### Features
- Full support for [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/)
    - [Markdown Basics](https://help.github.com/articles/basic-writing-and-formatting-syntax/)
    - [Markdown Syntax](https://daringfireball.net/projects/markdown/syntax)
- Full support for HTML.
- Full support for Magento features:
    - widgets
    - media storage (uploading and inserting images)
    - variables 
- Works for Magento products categories, CMS pages and CMS blocks.
- Autosaves the article as you type.
- Precise preview rendering.

**Demo video**: https://www.youtube.com/watch?v=gGL0IPJhzvY

### Screenshots

#### 1. Full-screen mode
![](https://mage2.pro/uploads/default/original/1X/de441d096b7dd5e54c3d886fa29d8a405255fd0c.png)

#### 2. Mini mode
![](https://mage2.pro/uploads/default/original/1X/1675cbee6eb9773ff030eed1a1dc208c02bcc035.png)

### How to install
[Hire me in Upwork](https://upwork.com/fl/mage2pro), and I will: 
- install and configure the module properly on your website
- answer your questions
- solve compatiblity problems with third-party checkout, shipping, marketing modules
- implement new features you need 

#### 2. Self-installation
```
bin/magento maintenance:enable
rm -f composer.lock
composer clear-cache
composer require mage2pro/markdown:*
bin/magento setup:upgrade
bin/magento cache:enable
rm -rf var/di var/generation generated/code
bin/magento setup:di:compile
rm -rf pub/static/*
bin/magento setup:static-content:deploy -f en_US <additional locales>
bin/magento maintenance:disable
```

### How to update
```
bin/magento maintenance:enable
composer remove mage2pro/markdown
rm -f composer.lock
composer clear-cache
composer require mage2pro/markdown:*
bin/magento setup:upgrade
bin/magento cache:enable
rm -rf var/di var/generation generated/code
bin/magento setup:di:compile
rm -rf pub/static/*
bin/magento setup:static-content:deploy -f en_US <additional locales>
bin/magento maintenance:disable
```

## Recent Versions

| Version | Released |
|---|---|
| 1.2.1 | 2023-08-06 |
| 1.2.0 | 2023-01-06 |
| 1.1.7 | 2019-11-15 |
| 1.1.6 | 2019-09-20 |
| 1.1.5 | 2019-06-05 |
| 1.1.4 | 2019-06-04 |
| 1.1.3 | 2019-03-16 |
| 1.1.2 | 2018-09-27 |
| 1.1.1 | 2018-09-27 |
| 1.1.0 | 2017-08-02 |

Showing 10 of 35 versions. Full release history on https://packagento.com/mage2pro/markdown.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| mage2pro/core | >=9.0.5 |

## Quality

Latest release (1.2.1) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | 1 | – |
| 2.4.9 | – | – | 1 | 1 |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Fail | 1133 | 11 errors, 1122 warnings (ruleset: Magento2) — 1094 auto-fixable with phpcbf |
| PHPMD | Warning | 5 | 5 rule violations (IfStatementAssignment:3, UnusedFormalParameter:2) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 2 | valid; 2 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 1125 | 1125 | – | – |
| 2.4.8 | – | 1124 | 1159 | – |
| 2.4.9 | – | – | 1160 | 1160 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["mage2pro/markdown"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

mage2pro is a Magento 2 vendor on Packagento. See https://packagento.com/mage2pro.md for their full catalogue.