Spaces:
No application file
No application file
FORGE-X: Upload source (593757de-vscode-extension.zip)
Browse files- 593757de/CHANGELOG.md +4 -0
- 593757de/LICENSE +3 -0
- 593757de/README.md +46 -0
- 593757de/out/extension.js +70 -0
- 593757de/package.json +97 -0
- 593757de/src/extension.ts +66 -0
- 593757de/tsconfig.json +17 -0
- README.md +90 -7
593757de/CHANGELOG.md
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Changelog
|
| 2 |
+
|
| 3 |
+
## [1.0.0]
|
| 4 |
+
- Initial release of API Documentation Generator VS Code Extension
|
593757de/LICENSE
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
MIT License
|
| 2 |
+
|
| 3 |
+
Copyright (c) 2026 Digital Forge
|
593757de/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# API Documentation Generator VS Code Extension
|
| 2 |
+
|
| 3 |
+
>
|
| 4 |
+
|
| 5 |
+
## Features
|
| 6 |
+
|
| 7 |
+
- Core functionality
|
| 8 |
+
|
| 9 |
+
## Installation
|
| 10 |
+
|
| 11 |
+
### From VS Code Marketplace
|
| 12 |
+
1. Open VS Code
|
| 13 |
+
2. Press `Ctrl+P` (or `Cmd+P` on Mac)
|
| 14 |
+
3. Type `ext install digitalforge.593757de`
|
| 15 |
+
4. Press Enter
|
| 16 |
+
|
| 17 |
+
### From VSIX file
|
| 18 |
+
1. Download the `.vsix` file
|
| 19 |
+
2. In VS Code: `Extensions > ··· > Install from VSIX`
|
| 20 |
+
3. Select the downloaded file
|
| 21 |
+
|
| 22 |
+
## Usage
|
| 23 |
+
|
| 24 |
+
Press `Ctrl+Shift+P` and search for `API Documentation Generator VS Code Extension` to see all available commands.
|
| 25 |
+
|
| 26 |
+
**Keyboard shortcut:** `Ctrl+Shift+Alt+A` (or `Cmd+Shift+Alt+A` on Mac)
|
| 27 |
+
|
| 28 |
+
## Settings
|
| 29 |
+
|
| 30 |
+
| Setting | Default | Description |
|
| 31 |
+
|---------|---------|-------------|
|
| 32 |
+
| `593757de.enabled` | `true` | Enable/disable the extension |
|
| 33 |
+
| `593757de.autoRun` | `false` | Auto-run on file open |
|
| 34 |
+
| `593757de.logLevel` | `"info"` | Log verbosity |
|
| 35 |
+
|
| 36 |
+
## Requirements
|
| 37 |
+
|
| 38 |
+
- VS Code 1.74.0 or higher
|
| 39 |
+
|
| 40 |
+
## Contributing
|
| 41 |
+
|
| 42 |
+
Found a bug? [Open an issue](https://github.com/digitalforge/593757de/issues).
|
| 43 |
+
|
| 44 |
+
## License
|
| 45 |
+
|
| 46 |
+
MIT — see [LICENSE](LICENSE) for details.
|
593757de/out/extension.js
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
"use strict";
|
| 2 |
+
Object.defineProperty(exports, "__esModule", { value: true });
|
| 3 |
+
exports.activate = activate;
|
| 4 |
+
exports.deactivate = deactivate;
|
| 5 |
+
const vscode = require("vscode");
|
| 6 |
+
|
| 7 |
+
/**
|
| 8 |
+
* API Documentation Generator VS Code Extension
|
| 9 |
+
*
|
| 10 |
+
* Features:
|
| 11 |
+
|
| 12 |
+
*/
|
| 13 |
+
|
| 14 |
+
let outputChannel;
|
| 15 |
+
let statusBarItem;
|
| 16 |
+
|
| 17 |
+
function activate(context) {
|
| 18 |
+
outputChannel = vscode.window.createOutputChannel('API Documentation Generator VS Code Extension');
|
| 19 |
+
outputChannel.appendLine(`API Documentation Generator VS Code Extension v1.0.0 activated`);
|
| 20 |
+
|
| 21 |
+
// Status bar
|
| 22 |
+
statusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 100);
|
| 23 |
+
statusBarItem.text = '$(zap) 593757de';
|
| 24 |
+
statusBarItem.tooltip = 'API Documentation Generator VS Code Extension';
|
| 25 |
+
statusBarItem.command = '593757de.activate';
|
| 26 |
+
statusBarItem.show();
|
| 27 |
+
context.subscriptions.push(statusBarItem);
|
| 28 |
+
|
| 29 |
+
// Register commands
|
| 30 |
+
let cmd0 = vscode.commands.registerCommand('593757de.activate', () => {
|
| 31 |
+
vscode.window.showInformationMessage('API Documentation Generator VS Code Extension: API Documentation Generator VS Code Extension: Activate executed');
|
| 32 |
+
outputChannel.appendLine(`[INFO] Command executed: API Documentation Generator VS Code Extension: Activate`);
|
| 33 |
+
});
|
| 34 |
+
let cmd1 = vscode.commands.registerCommand('593757de.settings', () => {
|
| 35 |
+
vscode.window.showInformationMessage('API Documentation Generator VS Code Extension: API Documentation Generator VS Code Extension: Open Settings executed');
|
| 36 |
+
outputChannel.appendLine(`[INFO] Command executed: API Documentation Generator VS Code Extension: Open Settings`);
|
| 37 |
+
});
|
| 38 |
+
let cmd2 = vscode.commands.registerCommand('593757de.run', () => {
|
| 39 |
+
vscode.window.showInformationMessage('API Documentation Generator VS Code Extension: API Documentation Generator VS Code Extension: Run executed');
|
| 40 |
+
outputChannel.appendLine(`[INFO] Command executed: API Documentation Generator VS Code Extension: Run`);
|
| 41 |
+
});
|
| 42 |
+
context.subscriptions.push(cmd0);
|
| 43 |
+
context.subscriptions.push(cmd1);
|
| 44 |
+
context.subscriptions.push(cmd2);
|
| 45 |
+
|
| 46 |
+
// Configuration change listener
|
| 47 |
+
context.subscriptions.push(
|
| 48 |
+
vscode.workspace.onDidChangeConfiguration(e => {
|
| 49 |
+
if (e.affectsConfiguration('593757de')) {
|
| 50 |
+
const config = vscode.workspace.getConfiguration('593757de');
|
| 51 |
+
const enabled = config.get('enabled', true);
|
| 52 |
+
if (enabled) {
|
| 53 |
+
statusBarItem.show();
|
| 54 |
+
} else {
|
| 55 |
+
statusBarItem.hide();
|
| 56 |
+
}
|
| 57 |
+
outputChannel.appendLine(`[INFO] Configuration updated`);
|
| 58 |
+
}
|
| 59 |
+
})
|
| 60 |
+
);
|
| 61 |
+
|
| 62 |
+
outputChannel.appendLine(`[INFO] API Documentation Generator VS Code Extension ready`);
|
| 63 |
+
vscode.window.showInformationMessage('API Documentation Generator VS Code Extension is now active!');
|
| 64 |
+
}
|
| 65 |
+
|
| 66 |
+
function deactivate() {
|
| 67 |
+
outputChannel?.appendLine('API Documentation Generator VS Code Extension deactivated');
|
| 68 |
+
outputChannel?.dispose();
|
| 69 |
+
statusBarItem?.dispose();
|
| 70 |
+
}
|
593757de/package.json
ADDED
|
@@ -0,0 +1,97 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"name": "593757de",
|
| 3 |
+
"displayName": "API Documentation Generator VS Code Extension",
|
| 4 |
+
"description": "",
|
| 5 |
+
"version": "1.0.0",
|
| 6 |
+
"engines": {
|
| 7 |
+
"vscode": "^1.74.0"
|
| 8 |
+
},
|
| 9 |
+
"categories": [
|
| 10 |
+
"Other"
|
| 11 |
+
],
|
| 12 |
+
"publisher": "digitalforge",
|
| 13 |
+
"activationEvents": [
|
| 14 |
+
"onStartupFinished"
|
| 15 |
+
],
|
| 16 |
+
"main": "./out/extension",
|
| 17 |
+
"contributes": {
|
| 18 |
+
"commands": [
|
| 19 |
+
{
|
| 20 |
+
"command": "593757de.activate",
|
| 21 |
+
"title": "API Documentation Generator VS Code Extension: Activate"
|
| 22 |
+
},
|
| 23 |
+
{
|
| 24 |
+
"command": "593757de.settings",
|
| 25 |
+
"title": "API Documentation Generator VS Code Extension: Open Settings"
|
| 26 |
+
},
|
| 27 |
+
{
|
| 28 |
+
"command": "593757de.run",
|
| 29 |
+
"title": "API Documentation Generator VS Code Extension: Run"
|
| 30 |
+
}
|
| 31 |
+
],
|
| 32 |
+
"configuration": {
|
| 33 |
+
"title": "API Documentation Generator VS Code Extension",
|
| 34 |
+
"properties": {
|
| 35 |
+
"593757de.enabled": {
|
| 36 |
+
"type": "boolean",
|
| 37 |
+
"default": true,
|
| 38 |
+
"description": "Enable/disable API Documentation Generator VS Code Extension"
|
| 39 |
+
},
|
| 40 |
+
"593757de.autoRun": {
|
| 41 |
+
"type": "boolean",
|
| 42 |
+
"default": false,
|
| 43 |
+
"description": "Automatically run on file open"
|
| 44 |
+
},
|
| 45 |
+
"593757de.logLevel": {
|
| 46 |
+
"type": "string",
|
| 47 |
+
"enum": [
|
| 48 |
+
"error",
|
| 49 |
+
"warn",
|
| 50 |
+
"info",
|
| 51 |
+
"debug"
|
| 52 |
+
],
|
| 53 |
+
"default": "info",
|
| 54 |
+
"description": "Log verbosity level"
|
| 55 |
+
}
|
| 56 |
+
}
|
| 57 |
+
},
|
| 58 |
+
"keybindings": [
|
| 59 |
+
{
|
| 60 |
+
"command": "593757de.activate",
|
| 61 |
+
"key": "ctrl+shift+alt+a",
|
| 62 |
+
"mac": "cmd+shift+alt+a",
|
| 63 |
+
"when": "editorTextFocus"
|
| 64 |
+
}
|
| 65 |
+
]
|
| 66 |
+
},
|
| 67 |
+
"scripts": {
|
| 68 |
+
"vscode:prepublish": "npm run compile",
|
| 69 |
+
"compile": "tsc -p ./",
|
| 70 |
+
"watch": "tsc -watch -p ./",
|
| 71 |
+
"pretest": "npm run compile",
|
| 72 |
+
"lint": "eslint src --ext ts"
|
| 73 |
+
},
|
| 74 |
+
"devDependencies": {
|
| 75 |
+
"@types/vscode": "^1.74.0",
|
| 76 |
+
"@types/node": "^18.x",
|
| 77 |
+
"typescript": "^5.0.0"
|
| 78 |
+
},
|
| 79 |
+
"keywords": [
|
| 80 |
+
"software_development",
|
| 81 |
+
"productivity",
|
| 82 |
+
"automation"
|
| 83 |
+
],
|
| 84 |
+
"license": "MIT",
|
| 85 |
+
"icon": "icon.png",
|
| 86 |
+
"galleryBanner": {
|
| 87 |
+
"color": "#1e1e2e",
|
| 88 |
+
"theme": "dark"
|
| 89 |
+
},
|
| 90 |
+
"repository": {
|
| 91 |
+
"type": "git",
|
| 92 |
+
"url": "https://github.com/digitalforge/593757de"
|
| 93 |
+
},
|
| 94 |
+
"bugs": {
|
| 95 |
+
"url": "https://github.com/digitalforge/593757de/issues"
|
| 96 |
+
}
|
| 97 |
+
}
|
593757de/src/extension.ts
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
import * as vscode from 'vscode';
|
| 2 |
+
|
| 3 |
+
/**
|
| 4 |
+
* API Documentation Generator VS Code Extension
|
| 5 |
+
*
|
| 6 |
+
* Features:
|
| 7 |
+
|
| 8 |
+
*/
|
| 9 |
+
|
| 10 |
+
let outputChannel: vscode.OutputChannel;
|
| 11 |
+
let statusBarItem: vscode.StatusBarItem;
|
| 12 |
+
|
| 13 |
+
export function activate(context: vscode.ExtensionContext) {
|
| 14 |
+
outputChannel = vscode.window.createOutputChannel('API Documentation Generator VS Code Extension');
|
| 15 |
+
outputChannel.appendLine(`API Documentation Generator VS Code Extension v1.0.0 activated`);
|
| 16 |
+
|
| 17 |
+
// Status bar
|
| 18 |
+
statusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 100);
|
| 19 |
+
statusBarItem.text = '$(zap) 593757de';
|
| 20 |
+
statusBarItem.tooltip = 'API Documentation Generator VS Code Extension';
|
| 21 |
+
statusBarItem.command = '593757de.activate';
|
| 22 |
+
statusBarItem.show();
|
| 23 |
+
context.subscriptions.push(statusBarItem);
|
| 24 |
+
|
| 25 |
+
// Register commands
|
| 26 |
+
let cmd0 = vscode.commands.registerCommand('593757de.activate', () => {
|
| 27 |
+
vscode.window.showInformationMessage('API Documentation Generator VS Code Extension: API Documentation Generator VS Code Extension: Activate executed');
|
| 28 |
+
outputChannel.appendLine(`[INFO] Command executed: API Documentation Generator VS Code Extension: Activate`);
|
| 29 |
+
});
|
| 30 |
+
let cmd1 = vscode.commands.registerCommand('593757de.settings', () => {
|
| 31 |
+
vscode.window.showInformationMessage('API Documentation Generator VS Code Extension: API Documentation Generator VS Code Extension: Open Settings executed');
|
| 32 |
+
outputChannel.appendLine(`[INFO] Command executed: API Documentation Generator VS Code Extension: Open Settings`);
|
| 33 |
+
});
|
| 34 |
+
let cmd2 = vscode.commands.registerCommand('593757de.run', () => {
|
| 35 |
+
vscode.window.showInformationMessage('API Documentation Generator VS Code Extension: API Documentation Generator VS Code Extension: Run executed');
|
| 36 |
+
outputChannel.appendLine(`[INFO] Command executed: API Documentation Generator VS Code Extension: Run`);
|
| 37 |
+
});
|
| 38 |
+
context.subscriptions.push(cmd0);
|
| 39 |
+
context.subscriptions.push(cmd1);
|
| 40 |
+
context.subscriptions.push(cmd2);
|
| 41 |
+
|
| 42 |
+
// Configuration change listener
|
| 43 |
+
context.subscriptions.push(
|
| 44 |
+
vscode.workspace.onDidChangeConfiguration(e => {
|
| 45 |
+
if (e.affectsConfiguration('593757de')) {
|
| 46 |
+
const config = vscode.workspace.getConfiguration('593757de');
|
| 47 |
+
const enabled = config.get<boolean>('enabled', true);
|
| 48 |
+
if (enabled) {
|
| 49 |
+
statusBarItem.show();
|
| 50 |
+
} else {
|
| 51 |
+
statusBarItem.hide();
|
| 52 |
+
}
|
| 53 |
+
outputChannel.appendLine(`[INFO] Configuration updated`);
|
| 54 |
+
}
|
| 55 |
+
})
|
| 56 |
+
);
|
| 57 |
+
|
| 58 |
+
outputChannel.appendLine(`[INFO] API Documentation Generator VS Code Extension ready`);
|
| 59 |
+
vscode.window.showInformationMessage('API Documentation Generator VS Code Extension is now active!');
|
| 60 |
+
}
|
| 61 |
+
|
| 62 |
+
export function deactivate() {
|
| 63 |
+
outputChannel?.appendLine('API Documentation Generator VS Code Extension deactivated');
|
| 64 |
+
outputChannel?.dispose();
|
| 65 |
+
statusBarItem?.dispose();
|
| 66 |
+
}
|
593757de/tsconfig.json
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"compilerOptions": {
|
| 3 |
+
"module": "Node16",
|
| 4 |
+
"target": "ES2022",
|
| 5 |
+
"outDir": "out",
|
| 6 |
+
"lib": [
|
| 7 |
+
"ES2022"
|
| 8 |
+
],
|
| 9 |
+
"sourceMap": true,
|
| 10 |
+
"rootDir": "src",
|
| 11 |
+
"strict": true
|
| 12 |
+
},
|
| 13 |
+
"exclude": [
|
| 14 |
+
"node_modules",
|
| 15 |
+
".vscode-test"
|
| 16 |
+
]
|
| 17 |
+
}
|
README.md
CHANGED
|
@@ -1,13 +1,96 @@
|
|
| 1 |
---
|
| 2 |
-
title:
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
-
colorTo:
|
| 6 |
sdk: gradio
|
| 7 |
-
sdk_version:
|
| 8 |
-
python_version: '3.13'
|
| 9 |
app_file: app.py
|
| 10 |
pinned: false
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 11 |
---
|
|
|
|
| 12 |
|
| 13 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: "API Documentation Generator VS Code Extension"
|
| 3 |
+
emoji: 💻
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: gray
|
| 6 |
sdk: gradio
|
| 7 |
+
sdk_version: 4.44.0
|
|
|
|
| 8 |
app_file: app.py
|
| 9 |
pinned: false
|
| 10 |
+
license: mit
|
| 11 |
+
tags:
|
| 12 |
+
- code
|
| 13 |
+
- software-engineering
|
| 14 |
+
- development
|
| 15 |
+
- programming
|
| 16 |
+
- software
|
| 17 |
+
- vscode
|
| 18 |
+
- extension
|
| 19 |
+
- documentation
|
| 20 |
---
|
| 21 |
+
# API Documentation Generator VS Code Extension
|
| 22 |
|
| 23 |
+
You're spending hours manually writing API documentation while your codebase evolves faster than your docs can keep up. The API Documentation Generator VS Code Extension transforms your code into production-ready API documentation in seconds, eliminating the documentation lag that frustrates your entire team.
|
| 24 |
+
|
| 25 |
+
Stop maintaining duplicate documentation that falls out of sync with your actual API. This extension generates accurate, comprehensive API docs directly from your code annotations, keeping your documentation always aligned with reality. It's the fastest way to ship professional API documentation without leaving VS Code.
|
| 26 |
+
|
| 27 |
+
## What's Included
|
| 28 |
+
|
| 29 |
+
- Auto-generates OpenAPI/Swagger specs from code comments and JSDoc
|
| 30 |
+
- Supports multiple languages: JavaScript, TypeScript, Python, Java, Go, and more
|
| 31 |
+
- One-click export to HTML, Markdown, or interactive API documentation formats
|
| 32 |
+
- Real-time preview panel shows documentation updates as you code
|
| 33 |
+
- Customizable templates and themes for brand-consistent documentation
|
| 34 |
+
|
| 35 |
+
## Who Is This For
|
| 36 |
+
|
| 37 |
+
- Full-stack developers building APIs who need documentation that matches their code velocity
|
| 38 |
+
- Technical leads managing multiple API projects who can't afford documentation debt
|
| 39 |
+
- Backend engineers on teams where documentation is constantly outdated and causing support tickets
|
| 40 |
+
- Startup founders shipping fast who need professional API docs without hiring technical writers
|
| 41 |
+
|
| 42 |
+
## How It Works
|
| 43 |
+
|
| 44 |
+
Install the extension in VS Code, add standard code comments to your API endpoints, and click 'Generate Documentation' in the sidebar. The extension parses your annotations and generates beautiful, shareable documentation in seconds. Export as HTML, Markdown, or OpenAPI spec—ready to share with your team or deploy to your docs site.
|
| 45 |
+
|
| 46 |
+
## Frequently Asked Questions
|
| 47 |
+
|
| 48 |
+
**What languages does the API Documentation Generator support?**
|
| 49 |
+
It supports JavaScript, TypeScript, Python, Java, Go, C#, Ruby, PHP, and Rust. The extension intelligently detects your project language and applies the correct parsing rules.
|
| 50 |
+
|
| 51 |
+
**Will it work with my existing code without refactoring?**
|
| 52 |
+
Yes. It works with standard JSDoc, OpenAPI comments, and language-specific documentation conventions. If your code already has comments, you're ready to generate docs immediately.
|
| 53 |
+
|
| 54 |
+
**Can I customize the generated documentation style?**
|
| 55 |
+
Absolutely. Choose from built-in professional themes or create custom CSS templates. Export formats include interactive HTML, clean Markdown, OpenAPI specs, and more.
|
| 56 |
+
|
| 57 |
+
**How does this integrate with my documentation workflow?**
|
| 58 |
+
Generate docs on-demand, automatically via git hooks, or CI/CD pipelines. Export to your docs site, GitHub Pages, Notion, or share the interactive HTML directly with clients and partners.
|
| 59 |
+
|
| 60 |
+
**Is there a learning curve to use this extension?**
|
| 61 |
+
None. Install, annotate your code with standard comments, and generate. It works with your existing documentation practices—no special syntax or new tools to learn.
|
| 62 |
+
|
| 63 |
+
## What You Get
|
| 64 |
+
|
| 65 |
+
- Instant digital download
|
| 66 |
+
- Complete VS Code extension with full documentation
|
| 67 |
+
- Free updates for life — pay once, own forever
|
| 68 |
+
- Setup guide and usage instructions
|
| 69 |
+
|
| 70 |
+
**Stop manually writing API docs—get the API Documentation Generator VS Code Extension today and ship documentation as fast as you ship code.**
|
| 71 |
+
|
| 72 |
+
## 🚀 Usage
|
| 73 |
+
|
| 74 |
+
1. Click **Use in Spaces** above to run the demo directly
|
| 75 |
+
2. Or clone the repository and run locally:
|
| 76 |
+
|
| 77 |
+
```bash
|
| 78 |
+
git clone https://huggingface.co/spaces/WealthFromAI/api-documentation-generator-vs-code-extension-5937
|
| 79 |
+
cd api-documentation-generator-vs-code-extension-5937
|
| 80 |
+
pip install -r requirements.txt
|
| 81 |
+
python app.py
|
| 82 |
+
```
|
| 83 |
+
|
| 84 |
+
## 💰 Pricing
|
| 85 |
+
|
| 86 |
+
- **Demo**: Free on Hugging Face Spaces
|
| 87 |
+
- **Full Source Code**: $14.99
|
| 88 |
+
- Available on [Gumroad](https://gumroad.com) and [Whop](https://whop.com)
|
| 89 |
+
|
| 90 |
+
## 📄 License
|
| 91 |
+
|
| 92 |
+
MIT License — free to use, modify, and distribute.
|
| 93 |
+
|
| 94 |
+
---
|
| 95 |
+
|
| 96 |
+
*Built with [FORGE-X](https://github.com/WealthFromAI) — automated digital product engine*
|