expressive-code - npm Package Compare versions

Comparing version 0.30.1 to 0.30.2

package.json

 {
   "name": "expressive-code",
-  "version": "0.30.1",
+  "version": "0.30.2",
   "description": "A text marking & annotation engine for presenting source code on the web.",
@@ -26,6 +26,6 @@ "keywords": [],
   "dependencies": {
-    "@expressive-code/core": "^0.30.1",
-    "@expressive-code/plugin-frames": "^0.30.1",
-    "@expressive-code/plugin-shiki": "^0.30.1",
-    "@expressive-code/plugin-text-markers": "^0.30.1"
+    "@expressive-code/core": "^0.30.2",
+    "@expressive-code/plugin-frames": "^0.30.2",
+    "@expressive-code/plugin-shiki": "^0.30.2",
+    "@expressive-code/plugin-text-markers": "^0.30.2"
   },
@@ -32,0 +32,0 @@ "scripts": {

README.md

 # expressive-code [![NPM version](https://img.shields.io/npm/v/expressive-code.svg)](https://www.npmjs.com/package/expressive-code) [![NPM downloads](https://img.shields.io/npm/dm/expressive-code.svg)](https://npmjs.org/package/expressive-code)
 
-## Contents
-
-- [What is this?](#what-is-this)
-- [When should I use this?](#when-should-i-use-this)
-- [Installation](#installation)
-- [Usage example](#usage-example)
-- [API](#api)
-  - [`ExpressiveCode`](#expressivecode)
-
-## What is this?
-
 A framework-agnostic wrapper package that provides convenient access to the key packages of Expressive Code, an engine for presenting source code on the web.
@@ -31,2 +20,6 @@
 
+## Documentation
+
+[Read the Expressive Code docs](https://expressive-code.com/) to learn more about the features provided by Expressive Code.
+
 ## Installation
@@ -71,31 +64,1 @@
 ```
-
-## API
-
-### `ExpressiveCode`
-
-The main class of `expressive-code`. It extends the [`ExpressiveCodeEngine`](https://github.com/expressive-code/expressive-code/blob/main/packages/%40expressive-code/core/README.md#expressivecodeengine) class and adds some configuration options.
-
-In addition to the [options provided by the core engine](https://github.com/expressive-code/expressive-code/blob/main/packages/%40expressive-code/core/README.md#expressivecodeengine-constructor), the following options are available:
-
-- `shiki: PluginShikiOptions | boolean`
-
-  Configures the Shiki plugin, which adds syntax highlighting to code blocks.
-
-  This plugin is enabled by default. Set this to `false` to disable it.
-
-  You can also configure the plugin by setting this to an [options object](https://github.com/expressive-code/expressive-code/blob/main/packages/%40expressive-code/plugin-shiki/README.md#available-plugin-options).
-
-- `textMarkers: boolean`
-
-  The Text Markers plugin allows to highlight lines and inline ranges in code blocks in various styles (e.g. marked, inserted, deleted).
-
-  This plugin is enabled by default. Set this to `false` to disable it.
-
-- `frames: PluginFramesOptions | boolean`
-
-  The Frames plugin adds an editor or terminal frame around code blocks, including an optional title displayed as a tab or window caption.
-
-  This plugin is enabled by default. Set this to `false` to disable it.
-
-  You can also configure the plugin by setting this to an [options object](https://github.com/expressive-code/expressive-code/blob/main/packages/%40expressive-code/plugin-frames/README.md#available-plugin-options).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

23694

decreased by-6.78%

Number of lines in readme file

63

decreased by-37%

Dependency changes

• Updated@expressive-code/core@^0.30.2

• Updated@expressive-code/plugin-frames@^0.30.2

• Updated@expressive-code/plugin-shiki@^0.30.2

• Updated@expressive-code/plugin-text-markers@^0.30.2