asmbs / wp-parsedown
Parsedown wrapper for WordPress with a live preview editor
Installs: 518
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 4
Forks: 1
Language:JavaScript
Type:wordpress-plugin
Requires
- php: >=7.2.0
- composer/installers: ^1.0
- erusev/parsedown: ^1.6
- erusev/parsedown-extra: ^0.8
README
Parsedown wrapper for WordPress with a live preview editor
This plugin serves two purposes:
- Replaces the classic WP editor with a Markdown editor with live preview (SimpleMDE)
- Forces all content to be rendered through Parsedown, converting saved Markdown content to HTML
This is a fork and a departure from the original friartuck6000/wp-parsedown.
The goal is to allow your site editors to use simplified, clean, familiar formatting.
An [image]
shortcode is also included for optional use, as Markdown only allows for crude image insertion. See the docs
folder for more information.
Requirements
- PHP 7.2+
- Composer
- "Classic Editor" plugin (if using WP v5+)
Installation
-
Install with Composer:
composer require asmbs/wp-parsedown
-
Activate the plugin.
Development
Requirements
- NPM
Getting Started
To install the development dependencies, run:
composer install
npm install
To rebuild the assets, run:
npx webpack
(Requires npx)