https://github.com/advanced-rest-client/highlight

A set of tools to work with markdown content and other syntax highlighting.
https://github.com/advanced-rest-client/highlight

Last synced: about 1 month ago
JSON representation

A set of tools to work with markdown content and other syntax highlighting.

• Host: GitHub
• URL: https://github.com/advanced-rest-client/highlight
• Owner: advanced-rest-client
• Created: 2021-06-12T05:56:32.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-02T22:01:28.000Z (almost 3 years ago)
• Last Synced: 2024-04-25T23:20:40.905Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 617 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# highlight

A set of tools to work with markdown content and other syntax highlighting.

This library replaces the old modules of:

- @advanced-rest-client/markdown-styles

- @advanced-rest-client/arc-marked

- @advanced-rest-client/prism-highlight

[![Published on NPM](https://img.shields.io/npm/v/@advanced-rest-client/highlight.svg)](https://www.npmjs.com/package/@advanced-rest-client/highlight)

[![Tests and publishing](https://github.com/advanced-rest-client/highlight/actions/workflows/deployment.yml/badge.svg)](https://github.com/advanced-rest-client/highlight/actions/workflows/deployment.yml)

## Usage

### Installation

```sh

npm install --save @advanced-rest-client/highlight

```

### MarkdownStyles

This should be used whenever the `arc-marked` is used.

```javascript

import { MarkdownStyles } from '@advanced-rest-client/highlight';

export default class AnElement extends LitElement {

  get styles() {

    return [

      MarkdownStyles,

      css`

        ...

      `

    ];

  }

  ...

}

```

### arc-marked

An element that specializes in markdown rendering.

```html

  


```

```html

  


  

    ## Markdown Renderer


    ...

  

```

## Development

```sh

git clone https://github.com/advanced-rest-client/arc-headers

cd arc-headers

npm install

```

### Running the demo locally

```sh

npm start

```

### Running the tests

```sh

npm test

```