@md-plugins/md-plugin-inlinecode 0.1.0-alpha.1 → 0.1.0-alpha.5

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 (3) hide show
  1. package/LICENSE.md +1 -1
  2. package/README.md +8 -11
  3. package/package.json +9 -4
package/LICENSE.md CHANGED
@@ -1,6 +1,6 @@
1
1
  The MIT License (MIT)
2
2
 
3
- Copyright (c) 2024-present, Jeff Galbraith
3
+ Copyright (c) 2024-present, MD-PLUGINS
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -26,21 +26,21 @@ pnpm add @md-plugins/md-plugin-inlinecode
26
26
  ### Basic Setup
27
27
 
28
28
  ```js
29
- import MarkdownIt from 'markdown-it';
30
- import { inlinecodePlugin } from '@md-plugins/md-plugin-inlinecode';
29
+ import MarkdownIt from 'markdown-it'
30
+ import { inlinecodePlugin } from '@md-plugins/md-plugin-inlinecode'
31
31
 
32
- const md = new MarkdownIt();
32
+ const md = new MarkdownIt()
33
33
  md.use(inlinecodePlugin, {
34
34
  inlineCodeClass: 'custom-inline-code-class',
35
- });
35
+ })
36
36
 
37
37
  const markdownContent = `
38
38
  Here is some \`inline code\` in a sentence.
39
- `;
39
+ `
40
40
 
41
- const renderedOutput = md.render(markdownContent);
41
+ const renderedOutput = md.render(markdownContent)
42
42
 
43
- console.log('Rendered Output:', renderedOutput);
43
+ console.log('Rendered Output:', renderedOutput)
44
44
  ```
45
45
 
46
46
  ### Example Output
@@ -48,10 +48,7 @@ console.log('Rendered Output:', renderedOutput);
48
48
  The rendered output will include the specified CSS class:
49
49
 
50
50
  ```html
51
- <p>
52
- Here is some <code class="custom-inline-code-class">inline code</code> in a
53
- sentence.
54
- </p>
51
+ <p>Here is some <code class="custom-inline-code-class">inline code</code> in a sentence.</p>
55
52
  ```
56
53
 
57
54
  ## Options
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@md-plugins/md-plugin-inlinecode",
3
- "version": "0.1.0-alpha.1",
3
+ "version": "0.1.0-alpha.5",
4
4
  "description": "A markdown-it plugin for handling inline code.",
5
5
  "keywords": [
6
6
  "markdown-it",
@@ -33,16 +33,21 @@
33
33
  "./dist"
34
34
  ],
35
35
  "dependencies": {
36
- "@types/markdown-it": "^14.1.2",
37
36
  "markdown-it": "^14.1.0",
38
- "@md-plugins/shared": "0.1.0-alpha.1"
37
+ "@md-plugins/shared": "0.1.0-alpha.5"
38
+ },
39
+ "devDependencies": {
40
+ "@types/markdown-it": "^14.1.2"
41
+ },
42
+ "peerDependencies": {
43
+ "markdown-it": "^14.1.0"
39
44
  },
40
45
  "publishConfig": {
41
46
  "access": "public"
42
47
  },
43
48
  "scripts": {
44
49
  "build": "unbuild",
45
- "clean": "rm -rf dist",
50
+ "clean": "rm -rf dist/ node_modules/",
46
51
  "test": "vitest"
47
52
  }
48
53
  }