@lukoweb/apitogo 0.2.52 → 0.2.54
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 +15 -2
- package/dist/cli/cli.js +662 -403
- package/dist/cli/worker.js +7 -1
- package/dist/declarations/cli/common/spawn-command.d.ts +3 -0
- package/dist/declarations/cli/platform/helpers/progress.d.ts +4 -1
- package/dist/declarations/lib/components/SiteTitle.d.ts +1 -0
- package/package.json +1 -1
- package/src/config/v2/docs-navigation.ts +11 -3
- package/src/config/v2/full-server.ts +1 -1
- package/src/config/v2/home-redirect.ts +39 -6
- package/src/config/v2/page-order.ts +73 -0
- package/src/config/v2/services.ts +5 -0
- package/src/config/v2/tsx-pages.ts +10 -1
- package/src/config/v2/wrapper.ts +12 -2
- package/src/lib/authentication/providers/dev-portal-auth-pages.tsx +18 -1
- package/src/lib/components/SiteTitle.tsx +69 -58
- package/src/vite/prerender/worker.ts +132 -118
package/README.md
CHANGED
|
@@ -56,10 +56,23 @@ Because great API documentation frameworks should be:
|
|
|
56
56
|
### ⚡️ Quick start
|
|
57
57
|
|
|
58
58
|
```
|
|
59
|
-
npx @lukoweb/apitogo@latest
|
|
59
|
+
npx @lukoweb/apitogo@latest create
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
|
|
62
|
+
`create` asks for a project name and sets up a folder for it. Add `--template full` for every service and a small
|
|
63
|
+
Node.js backend, or `--dry-run` to see every file it would make first.
|
|
64
|
+
|
|
65
|
+
### Install scripts (esbuild)
|
|
66
|
+
|
|
67
|
+
The portal build uses esbuild, which gets its binary in an install script. Newer npm versions warn about install
|
|
68
|
+
scripts and may skip them unless they are allowed (npm's `allow-scripts` setting, or `ignore-scripts`). The warning
|
|
69
|
+
for esbuild is expected: allow esbuild's script, or run it afterwards in the project folder:
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
npm rebuild esbuild
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Without it the build stops with an esbuild error about a missing binary.
|
|
63
76
|
|
|
64
77
|
---
|
|
65
78
|
|