Use markdown syntax on GNU social

Chimo e094b4b326 Normalize linebreaks 1 month ago
actions 6b0d4ec691 On/Off setting per-user 10 months ago
css 99b512ef0d Revert "[WIP] Per-notice markdown setting" 1 month ago
forms 6b0d4ec691 On/Off setting per-user 10 months ago
lib 91f711fbd6 Render bio with markdown in ProfileBlock 1 month ago
.gitignore 8540bf69e2 gitignore: Ignore vendor folder 1 year ago
LICENSE e27363d1a4 Add license 1 year ago
MarkdownPlugin.php e094b4b326 Normalize linebreaks 1 month ago
README.md eea1d63faa readme: Add 'install' section 3 months ago
composer.json 33ef4b1ff9 Add GFM support via config.php 1 year ago
composer.lock 33ef4b1ff9 Add GFM support via config.php 1 year ago

README.md

Use Markdown in your GNU social notices

Installation

  1. Navigate to your /local/plugins directory (create it if it doesn't exist)
  2. git clone https://github.com/chimo/gs-markdown.git Markdown

Activate the feature for your user account

Because the markdown plugin changes the way notices are rendered significantly, it is disabled by default.

Users can activate the plugin for their account in the "Settings > Markdown" section.

Built-in markdown parser

Make sure the files are in a folder called Markdown if they're not already
Put the folder in your /plugins/ directory
Tell /config.php to use it with:

    addPlugin('Markdown');

You can now use markdown syntax in your notices.

Github Flavored Markdown

If you want to use Github Flavored Markdown instead of the built-in markdown library, run composer install in the plugin directory (assuming you have composer installed).

And tell the plugin to use GFM by using the following in your /config.php:

    addPlugin('Markdown', array('parser' => 'gfm'));

You can now use GFM syntax in your notices.