npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

uniter-markdown-plugin

v1.0.1

Published

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

Downloads

10

Readme

Uniter markdown plugin (experimental)

Build Status

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

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

Create your unified platform config

uniter.config.js:

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

$name = 'Anastasia';
$where = 'here';

$myMarkdownTree = markdown {
### My intro
- Firstly, hello *$name*, how are _you_?
- Secondly, $where did you go?
};

return $myMarkdownTree->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:

$ uniter my_markdown.php

Limitations

Not designed for production use!

As above, 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

$myMarkdownTree = markdown {
    My plain text with * an asterisk.
};

will raise a PHP Parse error: syntax error, unexpected ... error. To overcome this, you'll need to backslash-escape the special character, like so:

my_markdown.php

<?php

$myMarkdownTree = markdown {
    My plain text with \* an asterisk.
};

print $myMarkdownTree->toHtml();

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

$ uniter my_markdown.php

My plain text with * an asterisk.

Keeping up to date