@md-plugins/shared 0.1.0-alpha.2 → 0.1.0-alpha.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +5 -1
  2. package/package.json +6 -3
package/README.md CHANGED
@@ -42,7 +42,7 @@ const env: MarkdownItEnv = {
42
42
  ```ts
43
43
  import { resolveTitleFromToken } from '@md-plugins/shared'
44
44
 
45
- const token = { content: 'My Title' }
45
+ const token = { content: '# My Title' }
46
46
  const title = resolveTitleFromToken(token, {
47
47
  shouldAllowHtml: false,
48
48
  shouldEscapeText: true,
@@ -98,6 +98,10 @@ function slugify(str: string): string
98
98
  - Converts a string into a URL-friendly slug.
99
99
  - Removes special characters and replaces spaces with hyphens.
100
100
 
101
+ ## Documentation
102
+
103
+ In case this README falls out of date, please refer to the [documentation](https://md-plugins.netlify.app/md-plugins/shared/overview) for the latest information.
104
+
101
105
  ## License
102
106
 
103
107
  This package is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@md-plugins/shared",
3
- "version": "0.1.0-alpha.2",
3
+ "version": "0.1.0-alpha.20",
4
4
  "description": "Shared functions and utilities for md-plugins.",
5
5
  "keywords": [
6
6
  "markdown-it",
@@ -32,8 +32,11 @@
32
32
  "files": [
33
33
  "./dist"
34
34
  ],
35
- "dependencies": {
36
- "@types/markdown-it": "^14.1.2",
35
+ "devDependencies": {
36
+ "markdown-it": "^14.1.0",
37
+ "@types/markdown-it": "^14.1.2"
38
+ },
39
+ "peerDependencies": {
37
40
  "markdown-it": "^14.1.0"
38
41
  },
39
42
  "publishConfig": {