@mdit-vue/plugin-toc - npm Package Compare versions

Comparing version 0.3.1 to 0.4.0

CHANGELOG.md

@@ -6,2 +6,6 @@ # Change Log
 
+# [0.4.0](https://github.com/mdit-vue/mdit-vue/compare/v0.3.1...v0.4.0) (2022-07-02)
+
+**Note:** Version bump only for package @mdit-vue/plugin-toc
+
 ## [0.3.1](https://github.com/mdit-vue/mdit-vue/compare/v0.3.0...v0.3.1) (2022-06-25)
@@ -8,0 +12,0 @@

dist/index.d.ts

@@ -11,2 +11,4 @@ import { MarkdownItHeader } from '@mdit-vue/shared';
      * The pattern serving as the TOC placeholder in your markdown
+     *
+     * @default /^\[\[toc\]\]$/i
      */
@@ -30,2 +32,4 @@ pattern?: RegExp;
      * to ensure the link is existed
+     *
+     * @default [2,3]
      */
@@ -35,2 +39,4 @@ level?: number[];
      * HTML tag of the TOC container
+     *
+     * @default 'nav'
      */
@@ -40,2 +46,4 @@ containerTag?: string;
      * The class for the TOC container
+     *
+     * @default 'table-of-contents'
      */
@@ -45,2 +53,4 @@ containerClass?: string;
      * HTML tag of the TOC list
+     *
+     * @default 'ul'
      */
@@ -50,2 +60,4 @@ listTag?: 'ul' | 'ol';
      * The class for the TOC list
+     *
+     * @default ''
      */
@@ -55,2 +67,4 @@ listClass?: string;
      * The class for the `<li>` tag
+     *
+     * @default ''
      */
@@ -60,2 +74,4 @@ itemClass?: string;
      * The tag of the link inside `<li>` tag
+     *
+     * @default 'a'
      */
@@ -65,2 +81,4 @@ linkTag?: 'a' | 'router-link';
      * The class for the link inside the `<li>` tag
+     *
+     * @default ''
      */
@@ -67,0 +85,0 @@ linkClass?: string;

package.json

 {
   "name": "@mdit-vue/plugin-toc",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "A markdown-it plugin to generate table-of-contents that compatible with Vue.js",
@@ -37,3 +37,3 @@ "keywords": [
   "dependencies": {
-    "@mdit-vue/shared": "0.3.0",
+    "@mdit-vue/shared": "0.4.0",
     "@types/markdown-it": "^12.2.3",
@@ -46,3 +46,3 @@ "markdown-it": "^13.0.1"
     "unbuild": "^0.7.4",
-    "vitest": "^0.15.2"
+    "vitest": "^0.16.0"
   },
@@ -52,3 +52,3 @@ "publishConfig": {
   },
-  "gitHead": "329b3e1c4b874ad07e838a93968ecbac3a333253"
+  "gitHead": "744887e6f4733af8da2045625e72a476947cfc25"
 }

README.md

 # @mdit-vue/plugin-toc
 
 [![npm](https://badgen.net/npm/v/@mdit-vue/plugin-toc)](https://www.npmjs.com/package/@mdit-vue/plugin-toc)
+[![license](https://badgen.net/github/license/mdit-vue/mdit-vue)](https://github.com/mdit-vue/mdit-vue/blob/main/LICENSE)
 
@@ -5,0 +6,0 @@ A [markdown-it](https://github.com/markdown-it/markdown-it) plugin to generate table-of-contents (TOC) that compatible with [Vue.js](https://vuejs.org).

src/types.ts

@@ -7,2 +7,4 @@ /**
    * The pattern serving as the TOC placeholder in your markdown
+   *
+   * @default /^\[\[toc\]\]$/i
    */
@@ -29,2 +31,4 @@ pattern?: RegExp;
    * to ensure the link is existed
+   *
+   * @default [2,3]
    */
@@ -35,2 +39,4 @@ level?: number[];
    * HTML tag of the TOC container
+   *
+   * @default 'nav'
    */
@@ -41,2 +47,4 @@ containerTag?: string;
    * The class for the TOC container
+   *
+   * @default 'table-of-contents'
    */
@@ -47,2 +55,4 @@ containerClass?: string;
    * HTML tag of the TOC list
+   *
+   * @default 'ul'
    */
@@ -53,2 +63,4 @@ listTag?: 'ul' | 'ol';
    * The class for the TOC list
+   *
+   * @default ''
    */
@@ -59,2 +71,4 @@ listClass?: string;
    * The class for the `<li>` tag
+   *
+   * @default ''
    */
@@ -65,2 +79,4 @@ itemClass?: string;
    * The tag of the link inside `<li>` tag
+   *
+   * @default 'a'
    */
@@ -71,4 +87,6 @@ linkTag?: 'a' | 'router-link';
    * The class for the link inside the `<li>` tag
+   *
+   * @default ''
    */
   linkClass?: string;
 }

tests/toc-plugin.spec.ts

@@ -44,3 +44,3 @@ import { slugify } from '@mdit-vue/shared';
 
-describe('@vuepress/markdown > plugins > tocPlugin', () => {
+describe('@mdit-vue/plugin-toc > toc-plugin', () => {
   describe('should render toc with default option (h2, h3)', () => {
@@ -47,0 +47,0 @@ const md = MarkdownIt().use(tocPlugin);

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

Improved metrics

Total package byte prevSize

32791

increased by2.15%

Lines of code

728

increased by5.2%

Number of lines in readme file

149

increased by0.68%

Dependency changes

• + Added@mdit-vue/shared@0.4.0(transitive)

• - Removed@mdit-vue/shared@0.3.0(transitive)

• Updated@mdit-vue/shared@0.4.0