@qui-cli/markdown 1.0.1 → 1.1.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.
 
+## [1.1.0](https://github.com/battis/qui-cli/compare/markdown/1.0.1...markdown/1.1.0) (2025-11-12)
+
+
+### Features
+
+* adjust heading level for Markdown prettiness ([88a651e](https://github.com/battis/qui-cli/commit/88a651e91a47b1b1b4814676c436c4845910c21a))
+
 ## [1.0.1](https://github.com/battis/qui-cli/compare/markdown/1.0.0...markdown/1.0.1) (2025-11-07)
 
 ### Bug Fixes

package/dist/Markdown.d.ts

@@ -3,6 +3,7 @@ export type Configuration = Plugin.Configuration & {
     outputPath?: string;
     fileName?: string;
     pre?: string;
+    headingLevelAdjustment?: number;
     post?: string;
     overwrite?: boolean;
 };

package/dist/Markdown.js

@@ -9,12 +9,14 @@ export const name = 'markdown';
 let outputPath = '.';
 let fileName = 'usage.md';
 let pre = '';
+let headingLevelAdjustment = 0;
 let post = '';
 let overwrite = false;
 export function configure(config = {}) {
     outputPath = Plugin.hydrate(config.outputPath, outputPath);
     fileName = Plugin.hydrate(config.fileName, fileName);
     pre = Plugin.hydrate(config.pre, pre);
+    headingLevelAdjustment = Plugin.hydrate(config.headingLevelAdjustment, headingLevelAdjustment);
     post = Plugin.hydrate(config.post, post);
     overwrite = Plugin.hydrate(config.overwrite, overwrite);
 }
@@ -36,7 +38,19 @@ export async function run() {
         }
         fs.mkdirSync(path.dirname(outputPath), { recursive: true });
     }
-    fs.writeFileSync(outputPath, `${pre.length ? `${pre}\n` : ''}${stripAnsi(Core.usageMarkdown())
+    fs.writeFileSync(outputPath, `${pre.length ? `${pre}\n` : ''}${adjustHeadingLevel(stripAnsi(Core.usageMarkdown()))
         .replace('Usage:\n\n```', '## Usage:\n\n```bash')
-        .replace('## `-h --help', '## Arguments\n\n#### `-h --help')}${post.length ? `\n${post}` : ''}`);
+        .replace('#### `-h --help', '## Arguments\n\n#### `-h --help')}${post.length ? `\n${post}` : ''}`);
+}
+function adjustHeadingLevel(usage) {
+    return usage
+        .split('\n')
+        .map((line) => {
+        const [, heading] = line.match(/^(#+) /) || [];
+        if (heading) {
+            return line.replace(/^(#+)/, '#'.repeat(heading.length + headingLevelAdjustment));
+        }
+        return line;
+    })
+        .join('\n');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qui-cli/markdown",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "@qui-cli Plugin: Export usage as markdown",
   "homepage": "https://github.com/battis/qui-cli/tree/main/packages/markdown#readme",
   "repository": {
@@ -27,9 +27,9 @@
     "del-cli": "^6.0.0",
     "npm-run-all": "^4.1.5",
     "typescript": "^5.9.3",
-    "@qui-cli/core": "5.0.0",
     "@qui-cli/plugin": "4.0.0",
-    "@qui-cli/root": "3.0.2"
+    "@qui-cli/root": "3.0.4",
+    "@qui-cli/core": "5.0.0"
   },
   "peerDependencies": {
     "@qui-cli/core": "5.x",