Markdown extension for phpBB

  • 3 min read

Markdown extension for phpBB.

Build Status Latest Stable Version Code Quality License

Write Markdown text in posts, signature or private messages and it will be converted as HTML. It can be used instead of or alongside BBCodes.

It uses the plugins Litedown and PipeTables from s9e/TextFormatter. You can read more about the supported syntax in the official documentation:

Features

  • Use Markdown in posts, personal messages and signatures
  • Can be used instead of or alongside text formatted with BBCode
  • Configuration to enable/disable the use of Markdown globally in the ACP
  • Configuration to enable/disable the use of Markdown per user in the UCP
  • Set per user group permissions to use Markdown
  • Set per forum permissions to use Markdown
  • Posting option to disable Markdown only in the current message (see note below)
  • Add help page to explain users how write messages in Markdown
  • Support for Imgur extension

Preview

Board features Post settings Private message settings Signature settings Post group permissions Profile group permissions Private messages group permissions Forum permissions User posting defaults Markdown post Markdown private message Markdown signature Posting editor option

(Click to view in full size)

Requirements

  • PHP 5.6 or greater
  • phpBB 3.2 or greater

Note: You need phpBB 3.2.6 or greater (PHPBB3-15949, #5519) to use the custom posting editor option to disable Markdown in the signature.

Support

Installation

  • Download the latest release
  • Decompress the *.zip or *.tar.gz file
  • Copy the files and directories inside {PHPBB_ROOT}/ext/alfredoramos/markdown/
  • Go to your Administration Control Panel > Customize > Manage extensions
  • Click on Enable and confirm

Configuration

Administrator

To enable or disable globally:

  • Go to your Administration Control Panel > Board features > Allow Markdown
  • Change settings as needed
  • Click on Submit

To change forum permissions:

  • Go to your Administration Control Panel > Permissions > Forum permissions
  • Select the forums and click on Submit
  • Select the users or groups and click on Edit permissions
  • Select the users or groups and click on Advanced Permissions
  • Go to Content and change the settings as needed
  • Click on Apply all permissions

To change user group permissions:

  • Go to your Administration Control Panel > Permissions > Group permissions
  • Select the group and click on Submit
  • Click on Advanced permissions
  • Go to Post or Private messages and change settings as needed
  • Click on Apply all permissions

User

To change default posting settings:

  • Go to your User Control Panel > Board preferences > Posting defaults
  • Change the settings as needed
  • Click on Submit

To disable Markdown only in the current message (post, signature or private message):

  • Go down to the posting editor options
  • Check the option Disable Markdown
  • Click on Preview or Submit

Uninstallation

  • Go to your Administration Control Panel > Customize > Manage extensions
  • Click on Disable and confirm
  • Go back to Manage extensions > Markdown > Delete data and confirm

Upgrade

  • Uninstall the extension
  • Delete all the files inside {PHPBB_ROOT}/ext/alfredoramos/markdown/
  • Download the new version
  • Install the extension