cipemotion/commonmark

A League CommonMark extension.

Maintainers

Details

github.com/cipemotion/commonmark

Source

Issues

Installs: 20 630

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 4

Forks: 0

Open Issues: 0

v3.0.0 2021-07-26 12:17 UTC

Requires

Requires (Dev)

MIT 2b83cc069eb09e51ce3e6c4d4a01b345618df0b3

  • Alex Bouma <alex.woop@cipemotion.com>

This package is auto-updated.

Last update: 2024-10-26 19:05:28 UTC

README

Inline converter

The inline syntax is meant for using quick markup in text settings like comments where it doesn't make sense to have a full wysiwig editor but you do want to provide some formatting options to the user using markdown syntax.

Supports the following inline syntax:

  • _emphasis_ to <em>emphasis</em>
  • *bold* to <strong>bold</strong>
  • ~deleted~ to <del>deleted</del>
  • `code` to <code>code</code>
  • [link](https://url) to <a href="https://url">link</a>
  • ![link](https://url) to !<a href="https://url">link</a> (images are disabled)
  • newlines to paragraphs
  • stripping of html (can be disabled to allow HTML)

Usage

// When `$allowHtml` is `true` HTML is _not_ removed in the output, default is false
$converter = \CipeMotion\CommonMark\Markdown::getInlineConverter($allowHtml);

$html = $converter->convertToHtml('This is _awesome_!')->getContent();
// or
$html = (string)$converter->convertToHtml('This is _awesome_!');