@favware/syntax-highlighter-react - npm Package Compare versions

Comparing version 0.1.0-alpha.2 to 1.0.0

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+# [1.0.0](https://github.com/favware/syntax-highlighter/compare/v0.1.0-alpha.3...v1.0.0) (2020-06-12)
+
+**Note:** Version bump only for package @favware/syntax-highlighter-react
+
+
+
+
+
 # [0.1.0-alpha.2](https://github.com/favware/syntax-highlighter/compare/v0.1.0-alpha.1...v0.1.0-alpha.2) (2020-06-11)
@@ -8,0 +16,0 @@

package.json

 {
 	"name": "@favware/syntax-highlighter-react",
-	"version": "0.1.0-alpha.2",
+	"version": "1.0.0",
 	"description": "React bindings for @favware/syntax-highlighter-core",
@@ -61,3 +61,3 @@ "author": "@favware",
 	],
-	"gitHead": "e3e6b1fe9918d0210183bb738a590b930cc228bb"
+	"gitHead": "083735a85be79c40c7ab93e0e86782c77b7841b3"
 }

README.md

 <div align="center">
+
 <p>
+<a href="https://favware.tech/syntaxhighlighter"><img style="height: 200px" src="https://cdn.favware.tech/img/syntax-highlighter.png" height="200" alt="logo"/></a>
+</p>
+
+<p>
 <h1> @favware/syntax-highlighter-react </h1>
@@ -12,17 +17,17 @@ <h3> React bindings for favware/syntax-highlighter-core </h3>
 <p>
-<a href="https://www.npmjs.com/package/favware/syntax-highlighter-react">
-<img src="https://img.shields.io/npm/v/favware/syntax-highlighter-react.svg?maxAge=3600&logo=npm&style=flat-square" alt="NPM version" />
+<a href="https://www.npmjs.com/package/@favware/syntax-highlighter-react">
+<img src="https://img.shields.io/npm/v/@favware/syntax-highlighter-react.svg?maxAge=3600&logo=npm&style=flat-square" alt="NPM version" />
 </a>
 	
-<a href="https://www.npmjs.com/package/favware/syntax-highlighter-react">
-<img src="https://img.shields.io/npm/dt/favware/syntax-highlighter-react.svg?maxAge=3600&logo=npm&style=flat-square" alt="NPM downloads" />
+<a href="https://www.npmjs.com/package/@favware/syntax-highlighter-react">
+<img src="https://img.shields.io/npm/dt/@favware/syntax-highlighter-react.svg?maxAge=3600&logo=npm&style=flat-square" alt="NPM downloads" />
 </a>
 </p>
 <p>
-<a href="https://bundlephobia.com/result?p=favware/syntax-highlighter-react">
-<img src="https://img.shields.io/bundlephobia/min/favware/syntax-highlighter-react?label=minified&logo=webpack&maxAge=3600&style=flat-square" alt="Minified Size">
+<a href="https://bundlephobia.com/result?p=@favware/syntax-highlighter-react">
+<img src="https://img.shields.io/bundlephobia/min/@favware/syntax-highlighter-react?label=minified&logo=webpack&maxAge=3600&style=flat-square" alt="Minified Size">
 </a>
 
-<a href="https://bundlephobia.com/result?p=favware/syntax-highlighter-react">
-<img src="https://img.shields.io/bundlephobia/minzip/favware/syntax-highlighter-react?label=minzipped&logo=webpack&maxAge=3600&style=flat-square" alt="Minzipped Size">
+<a href="https://bundlephobia.com/result?p=@favware/syntax-highlighter-react">
+<img src="https://img.shields.io/bundlephobia/minzip/@favware/syntax-highlighter-react?label=minzipped&logo=webpack&maxAge=3600&style=flat-square" alt="Minzipped Size">
 </a>
@@ -63,3 +68,5 @@ </p>
 -   Copy code support
--   Supports many languages, see [Supported Languages]
+-   Supports many languages, see [Supported Languages](#supported-languages)
+-   Will default to using [Fira Code] as font family
+    -   The library first falls back to popular fonts such as [Cascadia Code] and [Meslo NGF] if it isn't available. If these are also not available it will go through various more popular coding fonts, ending in `monospace`
 
@@ -77,2 +84,4 @@ Check out the [live demo](https://syntax-highlighter.now.sh/) for further examples.
 
+[Sample on CodeSanbox](https://codesandbox.io/s/syntax-highlighter-react-bb90c)
+
 The syntax is kept fairly simple. Here's a basic example of some simple JavaScript code:
@@ -106,2 +115,6 @@
 [rahulbhooteshwar]: https://github.com/rahulbhooteshwar
+[prismjs]: https://prismjs.com/
+[fira code]: https://github.com/tonsky/FiraCode
+[cascadia code]: https://github.com/microsoft/cascadia-code
+[meslo ngf]: https://github.com/romkatv/powerlevel10k#meslo-nerd-font-patched-for-powerlevel10k
 [an issue]: https://github.com/favware/syntax-highlighter/issues/new

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

45489

2.19%

Number of low quality alerts

2

-33.33%

Number of lines in readme file

117

12.5%

No dependency changes