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

compose-code-highlighter

v1.0.1

Published

Highlight static code snippets with CodeMirror

Downloads

5

Readme

Compose Code Highlighter

Easily highlight static code snippets using the wonderful CodeMirror. This wraps the CodeMirror run mode feature and adds language aliases, and DOM interaction.

Build Status

Setup:

When requiring this module, be sure to also require the CodeMirror language modes for the languages you'll be working with. For example if you are going to use Ruby, C, and CSS, you might add this:

require('codemirror')
require('codemirror/mode/ruby/ruby')
require('codemirror/mode/clike/clike')
require('codemirror/mode/css/css')

See CodeMirror's mode documentation for a complete list of supported languages.

Usage

Code snippets can be any element (not just a <pre> block) but should either have a data-lang attribute to set the language or should have a classname matching matching lang-[language].

For example:

<pre data-lang='css'>
body {
  background: #c0ffee;
}
</pre>

<div class='lang-ruby'>
puts 'hello world'
</div>

Then to highlight all code snippets on the page:

Highlighter.highlight()

Alias languages

If your language doesn't seem to be highlighting properly, you can specify the mimetype that CodeMirror is using to identify your language. For Scss, you'd use data-lang="text/x-scss". That's kind of verbose so this library adds some aliases so you can go on using data-lang="scss" and it is converted before invoking CodeMirror.

aliases: {
  'bash'  : 'text/x-sh',
  'c'     : 'text/x-csrc',
  'html'  : 'text/html',
  'js'    : 'text/javascript',
  'json'  : 'application/json',
  'java'  : 'text/x-java',
  'markup': 'text/html',
  'sass'  : 'text/x-sass',
  'scss'  : 'text/x-scss',
  'sh'    : 'text/x-sh'
},

If you want to add aliases you can do so like this:

var Highlighter = require('compose-code-highlighter')
Highlighter.addAlias({
  'less': 'text/x-less'
})

I'm happy to accept pullrequests for adding aliases to the default list.