@lukoweb/create-apitogo 0.1.0
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.md +18 -0
- package/README.md +114 -0
- package/dist/index.js +72 -0
- package/dist/templates/default/js/.env.example +2 -0
- package/dist/templates/default/js/README-template.md +28 -0
- package/dist/templates/default/js/apis/openapi.yaml +806 -0
- package/dist/templates/default/js/apitogo.config.jsx +65 -0
- package/dist/templates/default/js/eslintrc.json +4 -0
- package/dist/templates/default/js/gitignore +32 -0
- package/dist/templates/default/js/pages/example.mdx +9 -0
- package/dist/templates/default/js/pages/introduction.mdx +16 -0
- package/dist/templates/default/js/public/logo-dark.png +0 -0
- package/dist/templates/default/js/public/logo-dark.svg +1 -0
- package/dist/templates/default/js/public/logo-light.png +0 -0
- package/dist/templates/default/js/public/logo-light.svg +1 -0
- package/dist/templates/default/ts/.env.example +2 -0
- package/dist/templates/default/ts/README-template.md +28 -0
- package/dist/templates/default/ts/apis/openapi.yaml +806 -0
- package/dist/templates/default/ts/apitogo.config.tsx +66 -0
- package/dist/templates/default/ts/eslintrc.json +6 -0
- package/dist/templates/default/ts/gitignore +32 -0
- package/dist/templates/default/ts/pages/example.mdx +9 -0
- package/dist/templates/default/ts/pages/introduction.mdx +16 -0
- package/dist/templates/default/ts/public/banner-dark.svg +100 -0
- package/dist/templates/default/ts/public/banner.svg +100 -0
- package/dist/templates/default/ts/public/logo-dark.png +0 -0
- package/dist/templates/default/ts/public/logo-dark.svg +1 -0
- package/dist/templates/default/ts/public/logo-light.png +0 -0
- package/dist/templates/default/ts/public/logo-light.svg +1 -0
- package/dist/templates/default/ts/tsconfig.json +16 -0
- package/dist/templates/index.ts +317 -0
- package/dist/templates/types.ts +22 -0
- package/dist/templates/zuplo/README-template.md +40 -0
- package/dist/templates/zuplo/apitogo.config.tsx +93 -0
- package/dist/templates/zuplo/gitignore +32 -0
- package/dist/templates/zuplo/pages/introduction.mdx +153 -0
- package/dist/templates/zuplo/pages/markdown.mdx +108 -0
- package/dist/templates/zuplo/public/banner-dark.svg +100 -0
- package/dist/templates/zuplo/public/banner.svg +100 -0
- package/dist/templates/zuplo/tsconfig.json +16 -0
- package/package.json +49 -0
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/** @type {import('@lukoweb/apitogo').ZudokuConfig} */
|
|
2
|
+
const config = {
|
|
3
|
+
site: {
|
|
4
|
+
logo: {
|
|
5
|
+
src: { light: "/logo-light.png", dark: "/logo-dark.png" },
|
|
6
|
+
alt: "APIToGo",
|
|
7
|
+
width: "130px",
|
|
8
|
+
},
|
|
9
|
+
},
|
|
10
|
+
navigation: [
|
|
11
|
+
{
|
|
12
|
+
type: "category",
|
|
13
|
+
label: "Documentation",
|
|
14
|
+
items: [
|
|
15
|
+
{
|
|
16
|
+
type: "category",
|
|
17
|
+
label: "Getting Started",
|
|
18
|
+
icon: "sparkles",
|
|
19
|
+
items: [
|
|
20
|
+
"/introduction",
|
|
21
|
+
{
|
|
22
|
+
type: "link",
|
|
23
|
+
icon: "folder-cog",
|
|
24
|
+
badge: {
|
|
25
|
+
label: "New",
|
|
26
|
+
color: "purple",
|
|
27
|
+
},
|
|
28
|
+
label: "API Reference",
|
|
29
|
+
to: "/api",
|
|
30
|
+
},
|
|
31
|
+
],
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
type: "category",
|
|
35
|
+
label: "Useful Links",
|
|
36
|
+
collapsible: false,
|
|
37
|
+
icon: "link",
|
|
38
|
+
items: [
|
|
39
|
+
{
|
|
40
|
+
type: "link",
|
|
41
|
+
icon: "book",
|
|
42
|
+
label: "APIToGo",
|
|
43
|
+
to: "https://apitogo.com",
|
|
44
|
+
},
|
|
45
|
+
],
|
|
46
|
+
},
|
|
47
|
+
],
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
type: "link",
|
|
51
|
+
to: "/api",
|
|
52
|
+
label: "API Reference",
|
|
53
|
+
},
|
|
54
|
+
],
|
|
55
|
+
redirects: [{ from: "/", to: "/introduction" }],
|
|
56
|
+
apis: [
|
|
57
|
+
{
|
|
58
|
+
type: "file",
|
|
59
|
+
input: "./apis/openapi.yaml",
|
|
60
|
+
path: "/api",
|
|
61
|
+
},
|
|
62
|
+
],
|
|
63
|
+
};
|
|
64
|
+
|
|
65
|
+
export default config;
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
|
|
2
|
+
|
|
3
|
+
# dependencies
|
|
4
|
+
/node_modules
|
|
5
|
+
/.pnp
|
|
6
|
+
.pnp.*
|
|
7
|
+
.yarn/*
|
|
8
|
+
!.yarn/patches
|
|
9
|
+
!.yarn/plugins
|
|
10
|
+
!.yarn/releases
|
|
11
|
+
!.yarn/versions
|
|
12
|
+
|
|
13
|
+
# testing
|
|
14
|
+
/coverage
|
|
15
|
+
|
|
16
|
+
# zudoku
|
|
17
|
+
/dist/
|
|
18
|
+
|
|
19
|
+
# misc
|
|
20
|
+
.DS_Store
|
|
21
|
+
*.pem
|
|
22
|
+
|
|
23
|
+
# debug
|
|
24
|
+
npm-debug.log*
|
|
25
|
+
yarn-debug.log*
|
|
26
|
+
yarn-error.log*
|
|
27
|
+
|
|
28
|
+
# env files (can opt-in for commiting if needed)
|
|
29
|
+
.env*
|
|
30
|
+
|
|
31
|
+
# typescript
|
|
32
|
+
*.tsbuildinfo
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Welcome to APIToGo
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
Thanks for choosing to use APIToGo to power your API documentation!
|
|
6
|
+
|
|
7
|
+
## Edit this page
|
|
8
|
+
|
|
9
|
+
To edit this page, open the `pages/introduction.mdx` file.
|
|
10
|
+
|
|
11
|
+
## Configuration
|
|
12
|
+
|
|
13
|
+
You can find the full configuration for your APIToGo site in the `apitogo.config.jsx` file.
|
|
14
|
+
|
|
15
|
+
For further information on how to customize your site, check out the
|
|
16
|
+
[APIToGo documentation](https://zudoku.dev/docs).
|
|
Binary file
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="120" height="24" fill="none" viewBox="0 0 120 24"><g fill="#fff"><path fill-rule="evenodd" d="M19.064 1.116A1.754 1.754 0 0 1 20.7 0h6.018c2.372 0 4.063 2.3 3.356 4.564l-1.939 6.203A1.758 1.758 0 0 1 26.459 12H18c-1.243 0-1.875 1.125-2.25 2.25-.291.873-2.39 6.265-3.314 8.634A1.754 1.754 0 0 1 10.8 24H4.782c-2.372 0-4.063-2.3-3.356-4.564l1.939-6.203A1.758 1.758 0 0 1 5.042 12H13.5c1.243 0 1.875-1.125 2.25-2.25.291-.873 2.39-6.265 3.314-8.634Z" clip-rule="evenodd"/><path d="M20.05 13.875c-.782 0-1.481.485-1.756 1.217l-2.747 7.325A1.172 1.172 0 0 0 16.645 24h7.06a4.688 4.688 0 0 0 4.39-3.042l1.171-3.125c.718-1.915-.697-3.958-2.743-3.958H20.05ZM8.17 0a4.688 4.688 0 0 0-4.389 3.042L2.61 6.167c-.718 1.915.698 3.958 2.743 3.958h6.473c.782 0 1.482-.485 1.756-1.217l2.747-7.325A1.172 1.172 0 0 0 15.231 0H8.17ZM37.2 18.436v-3.03l5.793-6.518-.027-.027c-.536.054-.59.054-1.153.054h-4.506V5.83h10.058v3.03l-5.82 6.518.027.026c.536-.053.616-.053 1.18-.053h4.666v3.084H37.2ZM55.222 18.731c-3.863-.027-5.981-2.44-5.981-5.847V5.831h3.7v6.785c0 1.77.779 2.87 2.28 2.897 1.637.027 2.334-1.073 2.334-2.87V5.83h3.701v7.08c0 3.245-2.494 5.847-6.034 5.82ZM85.19 18.731c-3.997 0-6.813-2.843-6.813-6.598s2.816-6.597 6.812-6.597c3.996 0 6.813 2.842 6.813 6.597 0 3.755-2.817 6.598-6.813 6.598Zm0-3.192c1.85 0 3.164-1.394 3.164-3.406 0-2.011-1.314-3.406-3.165-3.406-1.85 0-3.165 1.395-3.165 3.406 0 2.012 1.315 3.407 3.165 3.407ZM101.626 18.436l-4.292-6.92v6.92h-3.7V.145h3.7v10.54l4.023-4.854h4.292l-4.533 5.203 4.801 7.402h-4.291ZM113.02 18.731c-3.862-.027-5.981-2.44-5.981-5.847V5.831h3.702v6.785c0 1.77.777 2.87 2.279 2.897 1.636.027 2.334-1.073 2.334-2.87V5.83h3.701v7.08c0 3.245-2.494 5.847-6.035 5.82Z"/><path fill-rule="evenodd" d="M76.74.12h-3.922v5.975a7.44 7.44 0 0 0-2.891-.56c-3.996 0-6.813 2.843-6.813 6.598s2.817 6.598 6.813 6.598c3.958 0 6.759-2.79 6.811-6.492h.001V.12Zm-3.648 12.013c0 2.012-1.314 3.407-3.165 3.407-1.85 0-3.165-1.395-3.165-3.407 0-2.011 1.314-3.406 3.165-3.406 1.85 0 3.165 1.395 3.165 3.406Z" clip-rule="evenodd"/></g></svg>
|
|
Binary file
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="120" height="24" fill="none" viewBox="0 0 120 24"><g fill="#000"><path fill-rule="evenodd" d="M19.064 1.116A1.754 1.754 0 0 1 20.7 0h6.018c2.372 0 4.063 2.3 3.356 4.564l-1.939 6.203A1.758 1.758 0 0 1 26.459 12H18c-1.243 0-1.875 1.125-2.25 2.25-.291.873-2.39 6.265-3.314 8.634A1.754 1.754 0 0 1 10.8 24H4.782c-2.372 0-4.063-2.3-3.356-4.564l1.939-6.203A1.758 1.758 0 0 1 5.042 12H13.5c1.243 0 1.875-1.125 2.25-2.25.291-.873 2.39-6.265 3.314-8.634Z" clip-rule="evenodd"/><path d="M20.05 13.875c-.782 0-1.481.485-1.756 1.217l-2.747 7.325A1.172 1.172 0 0 0 16.645 24h7.06a4.688 4.688 0 0 0 4.39-3.042l1.171-3.125c.718-1.915-.697-3.958-2.743-3.958H20.05ZM8.17 0a4.688 4.688 0 0 0-4.389 3.042L2.61 6.167c-.718 1.915.698 3.958 2.743 3.958h6.473c.782 0 1.482-.485 1.756-1.217l2.747-7.325A1.172 1.172 0 0 0 15.231 0H8.17ZM37.2 18.436v-3.03l5.793-6.518-.027-.027c-.536.054-.59.054-1.153.054h-4.506V5.83h10.058v3.03l-5.82 6.518.027.026c.536-.053.616-.053 1.18-.053h4.666v3.084H37.2ZM55.222 18.731c-3.863-.027-5.981-2.44-5.981-5.847V5.831h3.7v6.785c0 1.77.779 2.87 2.28 2.897 1.637.027 2.334-1.073 2.334-2.87V5.83h3.701v7.08c0 3.245-2.494 5.847-6.034 5.82ZM85.19 18.731c-3.997 0-6.813-2.843-6.813-6.598s2.816-6.597 6.812-6.597c3.996 0 6.813 2.842 6.813 6.597 0 3.755-2.817 6.598-6.813 6.598Zm0-3.192c1.85 0 3.164-1.394 3.164-3.406 0-2.011-1.314-3.406-3.165-3.406-1.85 0-3.165 1.395-3.165 3.406 0 2.012 1.315 3.407 3.165 3.407ZM101.626 18.436l-4.292-6.92v6.92h-3.7V.145h3.7v10.54l4.023-4.854h4.292l-4.533 5.203 4.801 7.402h-4.291ZM113.02 18.731c-3.862-.027-5.981-2.44-5.981-5.847V5.831h3.702v6.785c0 1.77.777 2.87 2.279 2.897 1.636.027 2.334-1.073 2.334-2.87V5.83h3.701v7.08c0 3.245-2.494 5.847-6.035 5.82Z"/><path fill-rule="evenodd" d="M76.74.12h-3.922v5.975a7.44 7.44 0 0 0-2.891-.56c-3.996 0-6.813 2.843-6.813 6.598s2.817 6.598 6.813 6.598c3.958 0 6.759-2.79 6.811-6.492h.001V.12Zm-3.648 12.013c0 2.012-1.314 3.407-3.165 3.407-1.85 0-3.165-1.395-3.165-3.407 0-2.011 1.314-3.406 3.165-3.406 1.85 0 3.165 1.395 3.165 3.406Z" clip-rule="evenodd"/></g></svg>
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# APIToGo App
|
|
2
|
+
|
|
3
|
+
This APIToGo app was created with [`@lukoweb/create-apitogo`](https://apitogo.com).
|
|
4
|
+
|
|
5
|
+
## Getting Started
|
|
6
|
+
|
|
7
|
+
First, run the development server:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm run dev
|
|
11
|
+
# or
|
|
12
|
+
yarn dev
|
|
13
|
+
# or
|
|
14
|
+
pnpm dev
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
|
18
|
+
|
|
19
|
+
You can start editing the page by modifying `pages/intro.mdx`. You will see the content
|
|
20
|
+
automatically update as you save the file.
|
|
21
|
+
|
|
22
|
+
## Learn More
|
|
23
|
+
|
|
24
|
+
To learn more about APIToGo, you can visit [apitogo.com](https://apitogo.com).
|
|
25
|
+
|
|
26
|
+
To connect with the community join the
|
|
27
|
+
[GitHub Discussions](https://github.com/zuplo/zudoku/discussions) or
|
|
28
|
+
[Discord](https://discord.zudoku.dev).
|