# hljs-themes

> Scoped themes for highlight.js

Latest version **1.0.0** (published 2017-08-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install hljs-themes
pnpm add hljs-themes
yarn add hljs-themes
bun add hljs-themes
```

## 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 | 1.0.0 |
| Published | 2017-08-08 |
| First published | 2017-08-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Carlos Rodriguez |
| Maintainers | crodriguez1a |
| Keywords | highlightjs, hljs, themes, css, linenumbers, ember-themed-syntax |

## Links

- npm: https://www.npmjs.com/package/hljs-themes
- Repository: https://github.com/crodriguez1a/hljs-themes
- Homepage: https://github.com/crodriguez1a/hljs-themes#readme
- Issues: https://github.com/crodriguez1a/hljs-themes/issues
- npm.io page: https://npm.io/package/hljs-themes

## Alternatives

- [@oh-my-pi/pi-natives](https://npm.io/package/@oh-my-pi/pi-natives.md) — 51.8K weekly downloads
- [@capgo/capacitor-light-sensor](https://npm.io/package/@capgo/capacitor-light-sensor.md) — 3.0K weekly downloads
- [@heyhuynhgiabuu/pi-diff](https://npm.io/package/@heyhuynhgiabuu/pi-diff.md) — 492 weekly downloads
- [@lotsa/verdant-lang-asm](https://npm.io/package/@lotsa/verdant-lang-asm.md) — 38 weekly downloads
- [new-era-syntax](https://npm.io/package/new-era-syntax.md) — 20 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-08-08

## README

# hljs-themes

Scoped themes for [highlight.js](https://highlightjs.org/)

### Installation

```bash
yarn add hljs-themes
```

```bash
bower install hljs-themes --save
```

### Typical Theme
		
```scss
// typical-theme.scss
.hljs {
  // these styles override all other themes
}
```

### Scoped Theme

```scss
// scoped-theme.scss
.my-theme {
  .hljs {
     // now I can easily switch between themes or create a 
     // reusable component where a theme can passed as a parameter
  }
}
```
   
### Use Case

Using the [`ember-themed-syntax`](https://github.com/crodriguez1a/ember-themed-syntax) addon

```handlebars
{{#themed-syntax lang="handlebars" theme="github-gist"}}
  {{! code }}
{{/themed-syntax}}
```

### Demo

[http://demos.evolutionaryapps.com/EmberThemedSyntax](http://demos.evolutionaryapps.com/EmberThemedSyntax)

### Please Contribute

To contribute, [fork](https://github.com/crodriguez1a/hljs-themes) this branch and provide your theme **scoped to a corresponding namespace**. Also, please provide a `transparent` class for users who want to opt-out from using a background color. This project uses **SCSS**, but please compile and provide **SCSS**, **CSS**, and **minified CSS** file as well. Thanks!
	
```scss
// my-custom-hljs-theme.scss
.my-custom-hljs-theme {
  &.transparent  {
    .hljs {
      background: none;
    }
  }
  
  .hljs {
    //...
  }
}
```

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