@rcmade/hono-docs 1.0.26 → 1.0.28
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/README.md +5 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -142,7 +142,7 @@ yarn add -D @rcmade/hono-docs
|
|
|
142
142
|
.route("/docs", docs)
|
|
143
143
|
.route("/user", userRoutes);
|
|
144
144
|
|
|
145
|
-
// ❌ This AppType is not supported
|
|
145
|
+
// ❌ This Group AppType is not supported
|
|
146
146
|
type AppType = typeof app;
|
|
147
147
|
```
|
|
148
148
|
|
|
@@ -206,7 +206,7 @@ yarn add -D @rcmade/hono-docs
|
|
|
206
206
|
```bash
|
|
207
207
|
npm run docs
|
|
208
208
|
# or
|
|
209
|
-
npx hono-docs generate --config ./hono-docs.ts
|
|
209
|
+
npx @rcmade/hono-docs generate --config ./hono-docs.ts
|
|
210
210
|
```
|
|
211
211
|
|
|
212
212
|
You’ll see:
|
|
@@ -309,7 +309,7 @@ All options live in your `defineConfig({ ... })` object:
|
|
|
309
309
|
## CLI Usage
|
|
310
310
|
|
|
311
311
|
```text
|
|
312
|
-
Usage: hono-docs generate --config <path> [--output <file>]
|
|
312
|
+
Usage: @rcmade/hono-docs generate --config <path> [--output <file>]
|
|
313
313
|
|
|
314
314
|
Options:
|
|
315
315
|
-c, --config Path to your config file (TS or JS) [string] [required]
|
|
@@ -326,10 +326,8 @@ You can use the API directly in code:
|
|
|
326
326
|
import { runGenerate, defineConfig } from "@rcmade/hono-docs";
|
|
327
327
|
|
|
328
328
|
(async () => {
|
|
329
|
-
const
|
|
330
|
-
|
|
331
|
-
});
|
|
332
|
-
await runGenerate(cfg as any);
|
|
329
|
+
const cfgPath = 'yourHonoDocs.ts'
|
|
330
|
+
await runGenerate(cfgPath);
|
|
333
331
|
})();
|
|
334
332
|
```
|
|
335
333
|
|