# ape-highlighting

> ape framework module for highlighting.

Latest version **3.1.0** (published 2016-06-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install ape-highlighting
pnpm add ape-highlighting
yarn add ape-highlighting
bun add ape-highlighting
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.0 |
| Published | 2016-06-10 |
| First published | 2015-11-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | okunishinishi |
| Maintainers | okunishinishi |
| Keywords | ape, highlighting |

## Links

- npm: https://www.npmjs.com/package/ape-highlighting
- Repository: https://github.com/ape-repo/ape-highlighting
- Homepage: https://github.com/ape-repo/ape-highlighting#readme
- Issues: https://github.com/ape-repo/ape-highlighting/issues
- npm.io page: https://npm.io/package/ape-highlighting

## Dependencies (2)

- [jsx-syntaxhighlighter](https://npm.io/package/jsx-syntaxhighlighter.md) ^0.1.0
- [node-syntaxhighlighter](https://npm.io/package/node-syntaxhighlighter.md) ^0.8.1

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 3.1.0 (latest) — 2016-06-10
- 3.0.0 — 2016-05-01
- 2.0.1 — 2015-11-28
- 2.0.0 — 2015-11-22
- 1.1.0 — 2015-11-08
- 1.0.0 — 2015-11-08

## README

ape-highlighting
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/ape-repo/ape-highlighting
[bd_travis_url]: http://travis-ci.org/ape-repo/ape-highlighting
[bd_travis_shield_url]: http://img.shields.io/travis/ape-repo/ape-highlighting.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/ape-repo/ape-highlighting
[bd_travis_com_shield_url]: https://api.travis-ci.com/ape-repo/ape-highlighting.svg?token=
[bd_license_url]: https://github.com/ape-repo/ape-highlighting/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/ape-repo/ape-highlighting
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/ape-repo/ape-highlighting.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/ape-repo/ape-highlighting.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/ape-repo/ape-highlighting
[bd_gemnasium_shield_url]: https://gemnasium.com/ape-repo/ape-highlighting.svg
[bd_npm_url]: http://www.npmjs.org/package/ape-highlighting
[bd_npm_shield_url]: http://img.shields.io/npm/v/ape-highlighting.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

ape framework module for highlighting.

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>
Installation
-----

```bash
$ npm install ape-highlighting --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>
Usage
---------

#### Highlight JSX source code.

```javascript
'use strict'

const apeHighlighting = require('ape-highlighting')
const fs = require('fs')

let highlighed = apeHighlighting.highlightJsx(
  fs.readFileSync(require.resolve('../jsx/some-jsx.jsx'))
)

console.log(highlighed)

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/ape-repo/ape-highlighting/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [ape-repo](https://github.com/ape-repo)

<!-- Links End -->

---
_Source: https://npm.io/package/ape-highlighting · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._