Giter VIP home page Giter VIP logo

wp-commonmark's Introduction

CommonMark Plugin for WordPress

WP CommonMark is a plugin for WordPress that enables CommonMark: a strongly specified, highly compatible implementation of Markdown, inside of your WordPress installation.

You can write contents in Markdown using CommonMark latest spec 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.

WP CommonMark 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.

composer require starise/wp-commonmark

Then activate the plugin via wp-cli.

wp plugin activate wp-commonmark

via WordPress Admin Panel

  1. Download the latest release 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

Inspired by Markdown on Save by Mark Jaquith and Markdown module in Jetpack by Automattic.

Uses league/commonmark as default markdown parser

wp-commonmark's People

Contributors

starise avatar

Stargazers

Alpha Ng avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.