https://github.com/uniter/markdown-plugin

A Uniter plugin to add support for an inline Markdown syntax to PHP (experimental)
https://github.com/uniter/markdown-plugin

markdown php uniter

Last synced: about 2 months ago
JSON representation

A Uniter plugin to add support for an inline Markdown syntax to PHP (experimental)

• Host: GitHub
• URL: https://github.com/uniter/markdown-plugin
• Owner: uniter
• License: other
• Created: 2020-08-05T20:58:59.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-07T22:25:41.000Z (almost 4 years ago)
• Last Synced: 2024-10-13T14:26:31.542Z (3 months ago)
• Topics: markdown, php, uniter
• Language: TypeScript
• Homepage: https://github.com/uniter/markdown-plugin-example
• Size: 149 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE.txt

Awesome Lists containing this project

README

        
# Uniter markdown plugin (experimental)

[![Build Status](https://github.com/uniter/markdown-plugin/workflows/CI/badge.svg)](https://github.com/uniter/markdown-plugin/actions?query=workflow%3ACI)

Implements an inline [Markdown][] syntax in PHP for [Uniter][].

## What?

Please note that you *probably shouldn't use this in production*. It's intended to demonstrate the [unified platform config][] feature of Uniter only.

That said, feel free to contribute any improvements that still fit within that (admittedly contrived) use-case.

In reality, you'd probably want to avoid extending PHP's syntax for this particular feature, or at least perform a PHP source-to-source transpilation.

That said, PHP currently lacks a source-map equivalent, so you'd probably have to bunch your generated code up onto a smaller number of lines

in order to maintain the correct line numbers after transpilation.

## I understand, but how do I use it?

### Install the dependencies

```shell

$ npm install --save uniter uniter-markdown-plugin

```

### Create your unified platform config

`uniter.config.js`:

```javascript

module.exports = {

    'plugins': [

        // Import this plugin itself

        require('uniter-markdown-plugin'),

    ],

};

```

### Use it in a script

Note that interpolation works too:

`my_markdown.php`:

```php

toHtml();

```

### Run it

Note that the `uniter.config.js` file [will be detected automatically][],

assuming it is in the same folder as your entry script:

```shell

$ uniter my_markdown.php

```

## Limitations

### Not designed for production use!

[As above](#what), I don't recommend you use this plugin in production - but feel free to experiment!

### "Free" special characters are not consistently supported

Something like the following:

```php

toHtml();

```

\- this should then give the desired result. Note that the backslash will be removed:

```shell

$ uniter my_markdown.php

My plain text with * an asterisk.

```

Keeping up to date

------------------

- [Follow me on Twitter](https://twitter.com/@asmblah) for updates: [https://twitter.com/@asmblah](https://twitter.com/@asmblah)

[Markdown]: https://daringfireball.net/projects/markdown/syntax

[Uniter]: https://github.com/asmblah/uniter

[unified platform config]: https://uniter.github.io/docs/uniter/config.html#unified-platform-config

[will be detected automatically]: https://uniter.github.io/docs/uniter/config.html#automatic-config-detection