/ParsedownExtended

Extension for Parsedown

Primary LanguagePHPMIT LicenseMIT

ParsedownExtended

Parsedown Extended

Explore Documentation »

Report bug · Request feature · Discussions


Github All Releases GitHub

Table of contents

Features

  • Task
  • Smartypants
  • Emojis
  • Heading permalink
  • Table of content
  • Keystrokes
  • Highlight
  • Super and subscript
  • Diagrams
  • LaTeX
  • Predefined abbreviation
  • Options for every element of markdown
  • And more...

Getting started

Manual

Download the source code from the latest release You must include parsedown.php 1.8+ Include ParsedownExtended.php

require 'Parsedown.php';
require 'ParsedownExtra.php'; // optional
require 'ParsedownExtended.php';

$ParsedownExtended = new ParsedownExtended();

echo $ParsedownExtended->text('Hello _Parsedown_!'); # prints: <p>Hello <em>Parsedown</em>!</p>
// you can also parse inline markdown only
echo $ParsedownExtended->line('Hello _Parsedown_!'); # prints: Hello <em>Parsedown</em>!

Using composer

From the command line interface, navigate to your project folder then run this command:

composer require benjaminhoegh/parsedown-extended

Then require the auto-loader file:

require 'vendor/autoload.php';

$ParsedownExtended = new ParsedownExtended();

echo $ParsedownExtended->text('Hello _Parsedown_!'); # prints: <p>Hello <em>Parsedown</em>!</p>
// you can also parse inline markdown only
echo $ParsedownExtended->line('Hello _Parsedown_!'); # prints: Hello <em>Parsedown</em>!

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

All PHP should conform to the Code Guide.

Community

Get updates on ParsedownExtended's development and chat with the project maintainers and community members.

Copyright and license

Code and documentation copyright 2021 the ParsedownExtended Authors. Code released under the MIT License. Docs released under Creative Commons.