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

@fullstackio/remark-cq

v7.0.1-treesitter.40

Published

Import code into markdown with cq

Downloads

135

Readme

remark-cq

remark plug-in to import code in markdown using cq

Supports exporting remark-attr-compatable metadata with code blocks.

Installation

npm:

npm install @fullstackio/remark-cq

Usage

For example:

var remark = require("remark");
var cq = require("@fullstackio/remark-cq");
const unified = require("unified");
const reParse = require("remark-parse");
const stringify = require("rehype-stringify");
const remark2rehype = require("remark-rehype");
const remarkStringify = require("remark-stringify");

const render = (text, config) =>
    unified()
        .use(reParse)
        .use(cq, config)
        .use(remark2rehype)
        .use(stringify)
        .process(text);

const markup = `
The code:

{lang=javascript,crop-query=.dogs}  
<<[](test.js)`;

const html = (await render(markup, { root: __dirname })).contents;

console.log(html);

Given a file test.js containing:

// test.js
var a = 1;
const dogs = () => "Like snuggles";
var b = 2;

Yields:

<p>The code:</p>
<pre><code class="language-javascript">const dogs = () => "Like snuggles";
</code></pre>

Similarly, you can render to markdown like this:

const renderMarkdown = (text, config) =>
    unified()
        .use(reParse)
        .use(remarkStringify)
        .use(cq, config)
        .process(text);

and then above example would render into:

The code:

```javascript
const dogs = () => "Like snuggles";
```

API

remark.use(cq, options)

Options

  • root: path to look for relative files
  • undent: undent the code (default true)
  • the rest are passed to cq

Use with Docusaurus

remark-cq can be used with Docusaurus easily. Just add the following to your docusaurus.config.js:

  remarkPlugins: [require("@fullstackio/remark-cq")]

For example, if you're using @docusaurus/preset-classic

presets: [
    "@docusaurus/preset-classic",
    {
       docs: { 
           remarkPlugins: [require("@fullstackio/remark-cq")]
       }
    }
]

License

MIT © Nate Murray