sourcey 2.0.2
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/LICENSE +23 -0
- package/README.md +254 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +197 -0
- package/dist/cli.js.map +1 -0
- package/dist/client/copy.js +21 -0
- package/dist/client/index.d.ts +7 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +8 -0
- package/dist/client/index.js.map +1 -0
- package/dist/client/scroll-tracker.js +88 -0
- package/dist/client/search.js +164 -0
- package/dist/client/sidebar.js +54 -0
- package/dist/client/tabs.js +51 -0
- package/dist/client/theme-toggle.js +36 -0
- package/dist/components/App.d.ts +15 -0
- package/dist/components/App.d.ts.map +1 -0
- package/dist/components/App.js +13 -0
- package/dist/components/App.js.map +1 -0
- package/dist/components/layout/Head.d.ts +2 -0
- package/dist/components/layout/Head.d.ts.map +1 -0
- package/dist/components/layout/Head.js +29 -0
- package/dist/components/layout/Head.js.map +1 -0
- package/dist/components/layout/Header.d.ts +13 -0
- package/dist/components/layout/Header.d.ts.map +1 -0
- package/dist/components/layout/Header.js +38 -0
- package/dist/components/layout/Header.js.map +1 -0
- package/dist/components/layout/Page.d.ts +2 -0
- package/dist/components/layout/Page.d.ts.map +1 -0
- package/dist/components/layout/Page.js +29 -0
- package/dist/components/layout/Page.js.map +1 -0
- package/dist/components/layout/Sidebar.d.ts +9 -0
- package/dist/components/layout/Sidebar.d.ts.map +1 -0
- package/dist/components/layout/Sidebar.js +41 -0
- package/dist/components/layout/Sidebar.js.map +1 -0
- package/dist/components/layout/TableOfContents.d.ts +10 -0
- package/dist/components/layout/TableOfContents.d.ts.map +1 -0
- package/dist/components/layout/TableOfContents.js +12 -0
- package/dist/components/layout/TableOfContents.js.map +1 -0
- package/dist/components/openapi/CodeSamples.d.ts +11 -0
- package/dist/components/openapi/CodeSamples.d.ts.map +1 -0
- package/dist/components/openapi/CodeSamples.js +16 -0
- package/dist/components/openapi/CodeSamples.js.map +1 -0
- package/dist/components/openapi/Definition.d.ts +11 -0
- package/dist/components/openapi/Definition.d.ts.map +1 -0
- package/dist/components/openapi/Definition.js +12 -0
- package/dist/components/openapi/Definition.js.map +1 -0
- package/dist/components/openapi/EndpointBar.d.ts +12 -0
- package/dist/components/openapi/EndpointBar.d.ts.map +1 -0
- package/dist/components/openapi/EndpointBar.js +22 -0
- package/dist/components/openapi/EndpointBar.js.map +1 -0
- package/dist/components/openapi/Introduction.d.ts +6 -0
- package/dist/components/openapi/Introduction.d.ts.map +1 -0
- package/dist/components/openapi/Introduction.js +14 -0
- package/dist/components/openapi/Introduction.js.map +1 -0
- package/dist/components/openapi/Operation.d.ts +13 -0
- package/dist/components/openapi/Operation.d.ts.map +1 -0
- package/dist/components/openapi/Operation.js +23 -0
- package/dist/components/openapi/Operation.js.map +1 -0
- package/dist/components/openapi/Parameters.d.ts +7 -0
- package/dist/components/openapi/Parameters.d.ts.map +1 -0
- package/dist/components/openapi/Parameters.js +10 -0
- package/dist/components/openapi/Parameters.js.map +1 -0
- package/dist/components/openapi/RequestBody.d.ts +17 -0
- package/dist/components/openapi/RequestBody.d.ts.map +1 -0
- package/dist/components/openapi/RequestBody.js +27 -0
- package/dist/components/openapi/RequestBody.js.map +1 -0
- package/dist/components/openapi/Responses.d.ts +14 -0
- package/dist/components/openapi/Responses.d.ts.map +1 -0
- package/dist/components/openapi/Responses.js +60 -0
- package/dist/components/openapi/Responses.js.map +1 -0
- package/dist/components/openapi/Security.d.ts +14 -0
- package/dist/components/openapi/Security.d.ts.map +1 -0
- package/dist/components/openapi/Security.js +32 -0
- package/dist/components/openapi/Security.js.map +1 -0
- package/dist/components/openapi/Tags.d.ts +8 -0
- package/dist/components/openapi/Tags.d.ts.map +1 -0
- package/dist/components/openapi/Tags.js +10 -0
- package/dist/components/openapi/Tags.js.map +1 -0
- package/dist/components/schema/ExampleView.d.ts +11 -0
- package/dist/components/schema/ExampleView.d.ts.map +1 -0
- package/dist/components/schema/ExampleView.js +15 -0
- package/dist/components/schema/ExampleView.js.map +1 -0
- package/dist/components/schema/SchemaDatatype.d.ts +11 -0
- package/dist/components/schema/SchemaDatatype.d.ts.map +1 -0
- package/dist/components/schema/SchemaDatatype.js +36 -0
- package/dist/components/schema/SchemaDatatype.js.map +1 -0
- package/dist/components/schema/SchemaView.d.ts +14 -0
- package/dist/components/schema/SchemaView.d.ts.map +1 -0
- package/dist/components/schema/SchemaView.js +44 -0
- package/dist/components/schema/SchemaView.js.map +1 -0
- package/dist/components/ui/Badge.d.ts +11 -0
- package/dist/components/ui/Badge.d.ts.map +1 -0
- package/dist/components/ui/Badge.js +14 -0
- package/dist/components/ui/Badge.js.map +1 -0
- package/dist/components/ui/Markdown.d.ts +8 -0
- package/dist/components/ui/Markdown.d.ts.map +1 -0
- package/dist/components/ui/Markdown.js +13 -0
- package/dist/components/ui/Markdown.js.map +1 -0
- package/dist/components/ui/SectionLabel.d.ts +10 -0
- package/dist/components/ui/SectionLabel.d.ts.map +1 -0
- package/dist/components/ui/SectionLabel.js +9 -0
- package/dist/components/ui/SectionLabel.js.map +1 -0
- package/dist/config.d.ts +46 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +102 -0
- package/dist/config.js.map +1 -0
- package/dist/core/converter.d.ts +9 -0
- package/dist/core/converter.d.ts.map +1 -0
- package/dist/core/converter.js +29 -0
- package/dist/core/converter.js.map +1 -0
- package/dist/core/loader.d.ts +7 -0
- package/dist/core/loader.d.ts.map +1 -0
- package/dist/core/loader.js +92 -0
- package/dist/core/loader.js.map +1 -0
- package/dist/core/markdown-loader.d.ts +29 -0
- package/dist/core/markdown-loader.d.ts.map +1 -0
- package/dist/core/markdown-loader.js +65 -0
- package/dist/core/markdown-loader.js.map +1 -0
- package/dist/core/navigation.d.ts +51 -0
- package/dist/core/navigation.d.ts.map +1 -0
- package/dist/core/navigation.js +108 -0
- package/dist/core/navigation.js.map +1 -0
- package/dist/core/normalizer.d.ts +7 -0
- package/dist/core/normalizer.d.ts.map +1 -0
- package/dist/core/normalizer.js +472 -0
- package/dist/core/normalizer.js.map +1 -0
- package/dist/core/parser.d.ts +10 -0
- package/dist/core/parser.d.ts.map +1 -0
- package/dist/core/parser.js +34 -0
- package/dist/core/parser.js.map +1 -0
- package/dist/core/search-indexer.d.ts +25 -0
- package/dist/core/search-indexer.d.ts.map +1 -0
- package/dist/core/search-indexer.js +72 -0
- package/dist/core/search-indexer.js.map +1 -0
- package/dist/core/types.d.ts +236 -0
- package/dist/core/types.d.ts.map +1 -0
- package/dist/core/types.js +7 -0
- package/dist/core/types.js.map +1 -0
- package/dist/dev-server.d.ts +17 -0
- package/dist/dev-server.d.ts.map +1 -0
- package/dist/dev-server.js +202 -0
- package/dist/dev-server.js.map +1 -0
- package/dist/index.d.ts +62 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +166 -0
- package/dist/index.js.map +1 -0
- package/dist/renderer/context.d.ts +46 -0
- package/dist/renderer/context.d.ts.map +1 -0
- package/dist/renderer/context.js +22 -0
- package/dist/renderer/context.js.map +1 -0
- package/dist/renderer/html-builder.d.ts +37 -0
- package/dist/renderer/html-builder.d.ts.map +1 -0
- package/dist/renderer/html-builder.js +87 -0
- package/dist/renderer/html-builder.js.map +1 -0
- package/dist/renderer/static-renderer.d.ts +10 -0
- package/dist/renderer/static-renderer.d.ts.map +1 -0
- package/dist/renderer/static-renderer.js +17 -0
- package/dist/renderer/static-renderer.js.map +1 -0
- package/dist/themes/default/main.css +61 -0
- package/dist/themes/default/sourcey.css +425 -0
- package/dist/utils/code-samples.d.ts +8 -0
- package/dist/utils/code-samples.d.ts.map +1 -0
- package/dist/utils/code-samples.js +84 -0
- package/dist/utils/code-samples.js.map +1 -0
- package/dist/utils/example-generator.d.ts +12 -0
- package/dist/utils/example-generator.d.ts.map +1 -0
- package/dist/utils/example-generator.js +123 -0
- package/dist/utils/example-generator.js.map +1 -0
- package/dist/utils/highlighter.d.ts +10 -0
- package/dist/utils/highlighter.d.ts.map +1 -0
- package/dist/utils/highlighter.js +51 -0
- package/dist/utils/highlighter.js.map +1 -0
- package/dist/utils/html-id.d.ts +6 -0
- package/dist/utils/html-id.d.ts.map +1 -0
- package/dist/utils/html-id.js +11 -0
- package/dist/utils/html-id.js.map +1 -0
- package/dist/utils/http.d.ts +14 -0
- package/dist/utils/http.d.ts.map +1 -0
- package/dist/utils/http.js +97 -0
- package/dist/utils/http.js.map +1 -0
- package/dist/utils/markdown.d.ts +9 -0
- package/dist/utils/markdown.d.ts.map +1 -0
- package/dist/utils/markdown.js +18 -0
- package/dist/utils/markdown.js.map +1 -0
- package/dist/vite-plugin.d.ts +16 -0
- package/dist/vite-plugin.d.ts.map +1 -0
- package/dist/vite-plugin.js +92 -0
- package/dist/vite-plugin.js.map +1 -0
- package/package.json +78 -0
package/package.json
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "sourcey",
|
|
3
|
+
"version": "2.0.2",
|
|
4
|
+
"description": "Generate beautiful static API documentation from OpenAPI/Swagger specifications",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"engines": {
|
|
7
|
+
"node": ">=20"
|
|
8
|
+
},
|
|
9
|
+
"bin": {
|
|
10
|
+
"sourcey": "dist/cli.js"
|
|
11
|
+
},
|
|
12
|
+
"exports": {
|
|
13
|
+
".": {
|
|
14
|
+
"types": "./dist/index.d.ts",
|
|
15
|
+
"import": "./dist/index.js"
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"files": [
|
|
19
|
+
"dist",
|
|
20
|
+
"LICENSE"
|
|
21
|
+
],
|
|
22
|
+
"scripts": {
|
|
23
|
+
"build": "tsc && cp -r src/themes dist/ && cp src/client/*.js dist/client/",
|
|
24
|
+
"dev": "tsc --watch",
|
|
25
|
+
"test": "vitest run",
|
|
26
|
+
"test:watch": "vitest",
|
|
27
|
+
"lint": "eslint src/ test/",
|
|
28
|
+
"lint:fix": "eslint src/ test/ --fix",
|
|
29
|
+
"format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
|
|
30
|
+
"typecheck": "tsc --noEmit",
|
|
31
|
+
"demo": "npx tsx src/cli.ts build test/fixtures/cheese.yml -o .preview --logo test/fixtures/cheese.png",
|
|
32
|
+
"demo:dev": "npx tsx src/cli.ts dev test/fixtures/cheese.yml --logo test/fixtures/cheese.png",
|
|
33
|
+
"prepublishOnly": "npm run build"
|
|
34
|
+
},
|
|
35
|
+
"dependencies": {
|
|
36
|
+
"@preact/preset-vite": "^2.10.4",
|
|
37
|
+
"@readme/openapi-parser": "^4.0.0",
|
|
38
|
+
"@tailwindcss/typography": "^0.5.19",
|
|
39
|
+
"@tailwindcss/vite": "^4.2.2",
|
|
40
|
+
"citty": "^0.1.6",
|
|
41
|
+
"js-yaml": "^4.1.0",
|
|
42
|
+
"marked": "^15.0.0",
|
|
43
|
+
"preact": "^10.28.4",
|
|
44
|
+
"preact-render-to-string": "^6.6.6",
|
|
45
|
+
"shiki": "^4.0.2",
|
|
46
|
+
"swagger2openapi": "^7.0.8",
|
|
47
|
+
"tailwindcss": "^4.2.2",
|
|
48
|
+
"vite": "^8.0.1"
|
|
49
|
+
},
|
|
50
|
+
"devDependencies": {
|
|
51
|
+
"@types/js-yaml": "^4.0.9",
|
|
52
|
+
"@types/node": "^22.19.15",
|
|
53
|
+
"eslint": "^9.0.0",
|
|
54
|
+
"eslint-config-prettier": "^10.0.0",
|
|
55
|
+
"prettier": "^3.4.0",
|
|
56
|
+
"typescript": "^5.7.0",
|
|
57
|
+
"typescript-eslint": "^8.0.0",
|
|
58
|
+
"vitest": "^3.0.0"
|
|
59
|
+
},
|
|
60
|
+
"keywords": [
|
|
61
|
+
"openapi",
|
|
62
|
+
"swagger",
|
|
63
|
+
"api",
|
|
64
|
+
"documentation",
|
|
65
|
+
"static-site-generator",
|
|
66
|
+
"docs"
|
|
67
|
+
],
|
|
68
|
+
"author": "Kam Low <auscaster@gmail.com> (https://sourcey.com)",
|
|
69
|
+
"license": "MIT",
|
|
70
|
+
"repository": {
|
|
71
|
+
"type": "git",
|
|
72
|
+
"url": "git+https://github.com/sourcey/sourcey.git"
|
|
73
|
+
},
|
|
74
|
+
"bugs": {
|
|
75
|
+
"url": "https://github.com/sourcey/sourcey/issues"
|
|
76
|
+
},
|
|
77
|
+
"homepage": "https://github.com/sourcey/sourcey#readme"
|
|
78
|
+
}
|