@qui-cli/markdown 1.1.0 → 1.1.1

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.
package/CHANGELOG.md CHANGED
@@ -2,6 +2,13 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
4
4
 
5
+ ## [1.1.1](https://github.com/battis/qui-cli/compare/markdown/1.1.0...markdown/1.1.1) (2026-01-02)
6
+
7
+
8
+ ### Bug Fixes
9
+
10
+ * normalize peer dependencies ([cdd81b7](https://github.com/battis/qui-cli/commit/cdd81b7c4bea7c769021ff58177750c5a1369f76))
11
+
5
12
  ## [1.1.0](https://github.com/battis/qui-cli/compare/markdown/1.0.1...markdown/1.1.0) (2025-11-12)
6
13
 
7
14
 
package/README.md CHANGED
@@ -39,6 +39,10 @@ Filename to use for output if `outputPath` is a path to a directory. Default: `"
39
39
 
40
40
  Any Markdown text to prepend to the output.
41
41
 
42
+ ### `headingLevelAdjustment`
43
+
44
+ Amount to increment (or decrement) heading levels in the Markdown output.
45
+
42
46
  ### `post`
43
47
 
44
48
  Any Markdown text to append to the output.
@@ -1,10 +1,24 @@
1
1
  import * as Plugin from '@qui-cli/plugin';
2
2
  export type Configuration = Plugin.Configuration & {
3
+ /**
4
+ * Path to which to write Markdown output file. If the path does not exist, it
5
+ * will be created. If the path does not have a file extension, it will be
6
+ * assumed to be a directory path (unless it exists as a file), see
7
+ * [`fileName`](#fileName).
8
+ */
3
9
  outputPath?: string;
10
+ /**
11
+ * Filename to use for output if `outputPath` is a path to a directory.
12
+ * Default: `"usage.md"`.
13
+ */
4
14
  fileName?: string;
15
+ /** Any Markdown text to prepend to the output. */
5
16
  pre?: string;
17
+ /** Amount to increment (or decrement) heading levels in the Markdown output. */
6
18
  headingLevelAdjustment?: number;
19
+ /** Any Markdown text to append to the output. */
7
20
  post?: string;
21
+ /** Whether or not to overwrite an existing file with output. Default: `false` */
8
22
  overwrite?: boolean;
9
23
  };
10
24
  export declare const name = "markdown";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@qui-cli/markdown",
3
- "version": "1.1.0",
3
+ "version": "1.1.1",
4
4
  "description": "@qui-cli Plugin: Export usage as markdown",
5
5
  "homepage": "https://github.com/battis/qui-cli/tree/main/packages/markdown#readme",
6
6
  "repository": {
@@ -18,23 +18,23 @@
18
18
  "types": "./dist/index.d.ts",
19
19
  "dependencies": {
20
20
  "strip-ansi": "^7.1.2",
21
- "@qui-cli/colors": "3.1.0"
21
+ "@qui-cli/colors": "3.2.1"
22
22
  },
23
23
  "devDependencies": {
24
- "@tsconfig/node20": "^20.1.6",
25
- "@types/node": "^24.10.0",
26
- "commit-and-tag-version": "^12.6.0",
24
+ "@tsconfig/node20": "^20.1.8",
25
+ "@types/node": "^24.10.4",
26
+ "commit-and-tag-version": "^12.6.1",
27
27
  "del-cli": "^6.0.0",
28
28
  "npm-run-all": "^4.1.5",
29
29
  "typescript": "^5.9.3",
30
+ "@qui-cli/root": "3.0.6",
30
31
  "@qui-cli/plugin": "4.0.0",
31
- "@qui-cli/root": "3.0.4",
32
- "@qui-cli/core": "5.0.0"
32
+ "@qui-cli/core": "5.0.2"
33
33
  },
34
34
  "peerDependencies": {
35
- "@qui-cli/core": "5.x",
36
- "@qui-cli/plugin": "4.x",
37
- "@qui-cli/root": "3.x"
35
+ "@qui-cli/core": ">=4",
36
+ "@qui-cli/plugin": ">=3",
37
+ "@qui-cli/root": ">=3"
38
38
  },
39
39
  "target": "node",
40
40
  "scripts": {