Page 1 of 1

Markdown Tests, Added Capability to use Markdown in Posts

Posted: Mon Nov 02, 2020 12:56 am
by rockedge

@sc0ttman !!

Thanks for pointing out a good additional capability, using Markdown in posts to simplify copying and pasting from Github. This test of using Markdown is the README.md file from this extensions Github repo.

About

Markdown extension for phpBB.

ImageImageImage
ImageImageImage

Allows you to 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, PipeTables and TaskLists from the s9e/TextFormatter library.

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
  • Add help page to explain users how write messages in Markdown
  • Add indentation when pressing the tab key inside Markdown code blocks

Requirements

  • PHP 7.1.3 or greater
  • phpBB 3.3 or greater

Support

Donate

If you like or found my work useful and want to show some appreciation, you can consider supporting its development by giving a donation.

Image

Image

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

Re: Markdown Tests, Added Capability to use Markdown in Posts

Posted: Mon Nov 02, 2020 1:31 am
by sc0ttman

Looks good :thumbup:

Looks like the markdown parser is fussy about spaces after hashes to produce headings

I don't know if it will do stuff like

:+1

(a thumbs up)

From the preview, I think it might not ... ah well .. So FYI, I don't think it supports Github flavoured Mardown, just Lite-Markdown (whatever that is) - so maybe direct copy/paste won't always work..

But certainly makes it easier... and writing posts in general (for me, at least.. I write a most notes etc in Markdown these days..)

Thanks :)


Re: Markdown Tests, Added Capability to use Markdown in Posts

Posted: Mon Nov 02, 2020 1:58 am
by rockedge

I changed the first post to use the Markdown file from this extension's Github repo, which explains that it uses the plugins Litedown, PipeTables and TaskLists from the s9e/TextFormatter library to parse and render Markdown.
These are built into phpBB in the 3+ series.

Check this https://s9etextformatter.readthedocs.io ... s/Fatdown/ for the possiblity of expanding the Markdown functions.


Re: Markdown Tests, Added Capability to use Markdown in Posts

Posted: Mon Nov 02, 2020 9:52 am
by wiak
rockedge wrote: Mon Nov 02, 2020 12:56 am

@sc0ttman !!

Thanks for pointing out a good additional capability, using Markdown in posts to simplify copying and pasting from Github. This test of using Markdown is the README.md file from this extensions Github repo.

For more general info/discussion about markdown utilities I have posted in Additional Software - Business about some markdown tools/converters (downloadable and also online) I find particularly useful (there are many others of course):

viewtopic.php?p=9024#p9024