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

roommirror

v0.0.9

Published

Syntax highlight code blocks that is generated from Markdown with CodeMirror.

Downloads

21

Readme

RoomMirror

Syntax highlight code blocks generated from Markdown with CodeMirror.

doc in japanese

RoomMirror Doc: 日本語ドキュメント

install

npm install roommirror

usage

common settings

path to codemirror is "roommirror_root/node_modules/codemirror"

<link rel="stylesheet" href="codemirror/lib/codemirror.css">

and theme files...

<link rel="stylesheet" href="codemirror/theme/base16-dark.css">
<link rel="stylesheet" href="codemirror/theme/solarized.css">
<link rel="stylesheet" href="codemirror/theme/monokai.css">

in browser

<script src="browser/roommirror.js"></script>

or exclude CodeMirror...

<script src="path/to/codemirror.js"></script>
<script src="browser/rm_without_cm.js"></script>

and mode files...

<script src="codemirror/mode/htmlmixed/htmlmixed.js"></script>
<script src="codemirror/mode/javascript/javascript.js"></script>
<script src="codemirror/mode/css/css.js"></script>

in browserify

var RoomMirror = require('roommirror');

// and mode files...
require('codemirror/mode/htmlmixed/htmlmixed.js');
require('codemirror/mode/javascript/javascript.js');
require('codemirror/mode/css/css.js');

RoomMirror(qs) -> [CodeMirror]

  • parameter qs: css selector of elements you want syntax highlighting.
  • return [CodeMirror]: array of codemirror instances that highlighted code blocks.

RoomMirror.byAnnotation(qs) -> [CodeMirror]

  • parameter qs: css selector of previous elements you want syntax highlighting.
<p class="rm-a" data-eval="{ mode: 'javascript' }"></p>
<div>var test = 'test';</div>
  • return [CodeMirror]: array of codemirror instances that highlighted code blocks.

example for markdown

in markdown...

<p class="rm-a" data-eval="{ mode: 'javascript', lineNumbers: true }"></p>

    var test = 'test';
    var add = function(a, b) {
      return a + b;
    };

    [0, 1, 2, 3, 4].reduce(add, 0); // 10

generate to html...

<p class="rm-a" data-eval="{ mode: 'javascript', lineNumbers: true }"></p>
<pre><code>var test = 'test';
var add = function(a, b) {
  return a + b;
};

[0, 1, 2, 3, 4].reduce(add, 0); // 10</code></pre>

syntax highlighting

var roommirrors = RoomMirror.byAnnotation('.rm-a');

##demo

in myblog: メモを揉め