Skip to content

README.md

Latest commit

 

History

History
67 lines (52 loc) · 3.07 KB

README.md

File metadata and controls

67 lines (52 loc) · 3.07 KB
Raw
LizardByte icon

shared-web

Shared web assets for LizardByte projects.

GitHub stars NPM Monthly Downloads NPM Version CI Codecov SonarCloud

Overview

Common web assets for use in LizardByte projects.

CDN

Published package assets are available through jsDelivr. For example, a language icon can be embedded directly:

<img
  src="https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@latest/dist/language-icons/JavaScript.svg"
  alt="JavaScript"
  width="32"
  height="32"
/>

Replace latest with a published package version for an immutable URL. URL-encode icon filenames that contain spaces or other reserved characters.

Installation

Install via NPM registry

  1. Add the dependency to your package.json file: 
    npm install @lizardbyte/shared-web --ignore-scripts

Install via GitHub Package Registry

  1. Add a .npmrc file to the root of your project with the following contents.

    //npm.pkg.github.com/:_authToken=TOKEN
@lizardbyte:registry=https://npm.pkg.github.com

    Replace TOKEN with a valid GitHub token with read access to the package registry.

    See Authenticating with a personal access token for more information or alternative methods of authentication.

  2. Add the dependency to your package.json file:

    npm install @lizardbyte/shared-web --ignore-scripts