https://github.com/starise/wp-commonmark
Enable CommonMark, a strongly specified, highly compatible implementation of Markdown, in WordPress.
https://github.com/starise/wp-commonmark
Last synced: 4 months ago
JSON representation
Enable CommonMark, a strongly specified, highly compatible implementation of Markdown, in WordPress.
- Host: GitHub
- URL: https://github.com/starise/wp-commonmark
- Owner: starise
- License: mit
- Created: 2015-10-03T15:07:46.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-12-10T11:19:42.000Z (6 months ago)
- Last Synced: 2024-12-27T04:22:30.758Z (6 months ago)
- Language: PHP
- Size: 41 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# CommonMark Plugin for WordPress
WP CommonMark is a plugin for [WordPress](https://wordpress.org/) that enables [CommonMark](http://commonmark.org/): a strongly specified, highly compatible implementation of [Markdown](https://daringfireball.net/projects/markdown/syntax), inside of your WordPress installation.
You can write contents in Markdown using CommonMark [latest spec](http://spec.commonmark.org/) on a per-post basis. The markdown version of your post is stored separately, so you can deactivate this plugin at any moment without breaking things. You can keep some posts in HTML and write others in markdown or switch between both HTML and markdown revisions on the same post.
## How to use
You can manage the type of syntax used in your contents, simply by activating or de-activating the switch placed on the "Publish" metabox.
## Requirements
* PHP >= 5.4.0
* Wordpress >= 4.3.0
## Installation
You can install this plugin via command-line or the WordPress admin panel.
### via Command-line
Add WP CommonMark to project's dependencies using [Composer](https://getcomposer.org/).
```sh
composer require starise/wp-commonmark
```
Then activate the plugin via [wp-cli](http://wp-cli.org/commands/plugin/activate/).
```sh
wp plugin activate wp-commonmark
```
### via WordPress Admin Panel
1. Download the [latest release](https://github.com/starise/wp-commonmark/releases) of this repo.
2. In your WordPress admin panel, navigate to Plugins->Add New
3. Click Upload Plugin
4. Upload the zip file that you downloaded.
## Credits
Copyright © 2015 [Andrea Brandi](http://andreabrandi.com)
Inspired by [Markdown on Save](https://wordpress.org/plugins/markdown-on-save/) by Mark Jaquith and Markdown module in [Jetpack](https://wordpress.org/plugins/jetpack/) by Automattic.
Uses [league/commonmark](https://github.com/thephpleague/commonmark) as default markdown parser