@powerlines/plugin-marked 0.1.643 → 0.1.644

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 +28 -0
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -74,6 +74,34 @@ A Powerlines plugin to generate project code with [Marked](https://marked.js.org
74
74
 
75
75
  <!-- END doctoc -->
76
76
 
77
+ ## Features
78
+
79
+ - Renders Markdown to HTML through a shared [Marked](https://marked.js.org) instance.
80
+ - Exposes `this.marked.parse(src)` for use inside other hooks.
81
+ - Supports Marked options such as `gfm` and `breaks`.
82
+
83
+ ## Usage
84
+
85
+ Install the package:
86
+
87
+ ```bash
88
+ pnpm add @powerlines/plugin-marked
89
+ ```
90
+
91
+ Register the plugin in `powerlines.config.ts`:
92
+
93
+ ```ts
94
+ import { defineConfig } from "powerlines/config";
95
+ import { plugin as marked } from "@powerlines/plugin-marked";
96
+
97
+ export default defineConfig({
98
+ plugins: [marked({ gfm: true })],
99
+ marked: { gfm: true, breaks: false }
100
+ });
101
+ ```
102
+
103
+ Then run the Powerlines build for your project.
104
+
77
105
  ## Installing
78
106
 
79
107
  Using [pnpm](http://pnpm.io):
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@powerlines/plugin-marked",
3
- "version": "0.1.643",
3
+ "version": "0.1.644",
4
4
  "private": false,
5
5
  "description": "A Powerlines plugin to use the Marked markdown compiler to generate HTML.",
6
6
  "keywords": ["marked", "powerlines", "storm-software", "powerlines-plugin"],
@@ -94,15 +94,15 @@
94
94
  "@stryke/path": "^0.29.43",
95
95
  "@stryke/types": "^0.12.44",
96
96
  "defu": "^6.1.7",
97
- "powerlines": "^0.47.216"
97
+ "powerlines": "^0.47.217"
98
98
  },
99
99
  "devDependencies": {
100
- "@powerlines/plugin-plugin": "^0.12.629",
100
+ "@powerlines/plugin-plugin": "^0.12.630",
101
101
  "@types/node": "^25.9.9",
102
102
  "marked": "^17.0.6"
103
103
  },
104
104
  "peerDependencies": { "marked": ">=17.0.4" },
105
105
  "peerDependenciesMeta": { "marked": { "optional": false } },
106
106
  "publishConfig": { "access": "public" },
107
- "gitHead": "75efa1cc4eb8bc90093202669065576aa70fbfef"
107
+ "gitHead": "bb4e1f2b32a8bb9d20559ca7c3df3a2f30a0d14e"
108
108
  }