cable8mm/commonmark-unfenced

v1.0.0 2024-04-06 11:15 UTC

Requires

• league/commonmark: ^2.3

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• Jess Archer

README

Unleash your fenced code.

An extension for league/commonmark.

Installation

After installing the package, you will need to register the extension.

Using graham-campbell/markdown

In your config/markdown.php file, add the extension somewhere after the CommonMarkCoreExtension:

  return [
      // ...
      'extensions' => [
          League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension::class,
          League\CommonMark\Extension\GithubFlavoredMarkdownExtension::class,
+         Laravel\Unfenced\UnfencedExtension::class,
      ],
  ];

Manually

use Laravel\Unfenced\UnfencedExtension;
use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
use League\CommonMark\MarkdownConverter;

$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new UnfencedExtension());

$converter = new MarkdownConverter($environment);
echo $converter->convert('...');

Usage

Features are enabled via the "info" string of the code fence.

Note

This extension does not include any CSS.

Adding file names

To display a file name above your code, add the filename attribute:

```php filename=src/Hello.php
// ...
```

Adding tabs

Adjacent code fences can be grouped into a tabbed view by specifying the tab attribute:

```vue tab=Vue
// ...
```

```javascript tab=React
// ...
```

You may also include the filename attribute, which is especially helpful when providing code samples where the file name differs depending on the language:

```vue tab=Vue filename=Welcome.vue
// ...
```

```javascript tab=React filename=Welcome.jsx
// ...
```

The extension will inject JavaScript into your page when tabs are used. The JavaScript enables the following features:

• It will apply an active class to the active tab button and tab content. You may use CSS to highlight the active tab, and hide the inactive tab content.
• If multiple tabbed sections are found, and they contain identical tab names, they will be synchronized. I.e, clicking the "React" tab in one section, will switch to that tab in all sections.
• The active tab is saved to the browsers local storage so that it persists between pages and visits.