Skip to content

Joomla plugin translating remote linked markdown files to html

License

Notifications You must be signed in to change notification settings

ThomasFinnern/plg_remote_markdown

Repository files navigation

Plugin remote markdown

plg_content_remotemarkdown

Joomla plugin displaying remote markdown files linked in an article.

This Joomla! plugin will replace a 'link marker' to a *.md file in an article. with text created by the markdown file conversion to html. The 'link marker' can be written into any artikle in the form {remotemarkdown:http://.../...md}

The idea is to create user documentation in markdown on github and show it on a joomla web site.

The plugin uses the parsedown project https://github.com/erusev/parsedown to convert the *.md file (LICENSE file see folder)

State: Basic working example (No fringes)

Usage:

  • Install plugin
  • Activate plugin
  • Add following text to an article "{remotemarkdown:<http: file-url>}

Examples:

{remotemarkdown:http://127.0.0.1/readme.md}
{remotemarkdown:https://github.com/ThomasFinnern/plg_remote_markdown/raw/refs/heads/master/README.md}

Attention:

  • It won't display github flavoured markdown.
  • Following url/file can't be displayed proper

https://raw.githubusercontent.com/RSGallery2/RSGallery2_Project/master/Documentation/RSGallery2_documentation_J3.x.md

Possible Future features:

  • Caching of read files
  • Parameters also in article reference
  • User parameter prepared for extraction but not for use

About

Joomla plugin translating remote linked markdown files to html

Resources

License

Stars

Watchers

Forks

Packages

No packages published