Skip to content

Commit 86c39a6

Browse files
MihalyToth20MihalyToth20
committed
feat: docs enhancements
1 parent 9ffdfe4 commit 86c39a6

23 files changed

+610
-185
lines changed

‎.changeset/eight-states-hear.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@calycode/core": patch
3+
"@calycode/cli": patch
4+
---
5+
6+
feat: improvements to the documentation generation, added changelog links, full-text search, pagination plugin, terminaly plugin, flexible callouts plugin, dark mode support and mermaid support plugins

‎docs/_media/logo.png‎

171 KB
Loading

‎docs/_sidebar.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
- ### Core Commands:
1+
- Core command
22

33
- [xano - the core command](xano.md)
44

5-
- ### Features
5+
- Commands
66

77
- [`setup`](commands/setup.md)
8-
- [`switch-context`](commands/switch-context.md)
98
- [`generate-oas`](commands/generate-oas.md)
109
- [`serve-oas`](commands/serve-oas.md)
1110
- [`generate-code`](commands/generate-code.md)
@@ -19,8 +18,11 @@
1918
- [`run-test`](commands/run-test.md)
2019
- [`current-context`](commands/current-context.md)
2120

22-
---
21+
- Changelog
2322

24-
<small>Made with💖by the [OSOI.IO](https://osoi.io) Team</small>
23+
- [CLI](https://github.com/calycode/xano-tools/blob/main/packages/cli/CHANGELOG.md)
24+
- [CORE](https://github.com/calycode/xano-tools/blob/main/packages/core/CHANGELOG.md)
2525

26+
27+
<small>For devs with 💖 by devs at [calycode](https://calycode.com).</small>
2628
<small>Documentation powered by [Docsify.js](https://docsifyjs.org)</small>

‎docs/commands/current-context.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# current-context
2-
```sh
3-
xano current-context [options]
2+
```term
3+
$ xano current-context [options]
44
```
55
### Options
66

77

88
### current-context --help
9-
```sh
9+
```term
10+
$ xano current-context --help
1011
Usage: xano current-context [options]
1112
1213
Options:

‎docs/commands/export-backup.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# export-backup
2+
>[!NOTE|label:Description]
23
> #### Backup Xano Workspace via Metadata API
34
4-
```sh
5-
xano export-backup [options]
5+
```term
6+
$ xano export-backup [options]
67
```
78
### Options
89

@@ -16,19 +17,19 @@ xano export-backup [options]
1617
**Description:** Expose usable output path for further reuse.
1718

1819
### export-backup --help
19-
```sh
20+
```term
21+
$ xano export-backup --help
2022
Usage: xano export-backup [options]
2123
2224
Backup Xano Workspace via Metadata API
2325
2426
Options:
25-
--instance <instance> The instance name. This is used to fetch the instance
26-
configuration. The value provided at the setup
27-
command.
28-
--workspace <workspace> The workspace name. This is used to fetch the
29-
workspace configuration. Same as on Xano interface.
30-
--branch <branch> The branch name. This is used to select the branch
31-
configuration. Same as on Xano Interface.
27+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
28+
provided at the setup command.
29+
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on
30+
Xano interface.
31+
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
32+
Interface.
3233
--print-output-dir Expose usable output path for further reuse.
3334
-h, --help display help for command
3435
```

‎docs/commands/generate-code.md‎

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# generate-code
2+
>[!NOTE|label:Description]
23
> #### Create a library based on the OpenAPI specification. If the openapi specification has not yet been generated, this will generate that as well as the first step.
34
4-
```sh
5-
xano generate-code [options]
5+
```term
6+
$ xano generate-code [options]
67
```
78
### Options
89

@@ -26,30 +27,28 @@ xano generate-code [options]
2627
**Description:** Specify this flag in order to allow logging. Logs will appear in output/_logs. Default: false
2728

2829
### generate-code --help
29-
```sh
30+
```term
31+
$ xano generate-code --help
3032
Usage: xano generate-code [options]
3133
32-
Create a library based on the OpenAPI specification. If the openapi
33-
specification has not yet been generated, this will generate that as well as the
34-
first step.
34+
Create a library based on the OpenAPI specification. If the openapi specification has not yet been generated,
35+
this will generate that as well as the first step.
3536
3637
Options:
37-
--instance <instance> The instance name. This is used to fetch the instance
38-
configuration. The value provided at the setup
39-
command.
40-
--workspace <workspace> The workspace name. This is used to fetch the
41-
workspace configuration. Same as on Xano interface.
42-
--branch <branch> The branch name. This is used to select the branch
43-
configuration. Same as on Xano Interface.
38+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
39+
provided at the setup command.
40+
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on
41+
Xano interface.
42+
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
43+
Interface.
4444
--group <name> API group name. Same as on Xano Interface.
45-
--all Regenerate for all API groups in the workspace /
46-
branch of the current context.
45+
--all Regenerate for all API groups in the workspace / branch of the current context.
4746
--print-output-dir Expose usable output path for further reuse.
4847
--generator <generator> Generator to use, see all options at:
4948
https://openapi-generator.tech/docs/generators
5049
--args <args> Additional arguments to pass to the generator. See
5150
https://openapi-generator.tech/docs/usage#generate
52-
--debug Specify this flag in order to allow logging. Logs
53-
will appear in output/_logs. Default: false
51+
--debug Specify this flag in order to allow logging. Logs will appear in output/_logs.
52+
Default: false
5453
-h, --help display help for command
5554
```

‎docs/commands/generate-oas.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# generate-oas
2+
>[!NOTE|label:Description]
23
> #### Update and generate OpenAPI spec(s) for the current context.
34
4-
```sh
5-
xano generate-oas [options]
5+
```term
6+
$ xano generate-oas [options]
67
```
78
### Options
89

@@ -20,22 +21,21 @@ xano generate-oas [options]
2021
**Description:** Expose usable output path for further reuse.
2122

2223
### generate-oas --help
23-
```sh
24+
```term
25+
$ xano generate-oas --help
2426
Usage: xano generate-oas [options]
2527
2628
Update and generate OpenAPI spec(s) for the current context.
2729
2830
Options:
29-
--instance <instance> The instance name. This is used to fetch the instance
30-
configuration. The value provided at the setup
31-
command.
32-
--workspace <workspace> The workspace name. This is used to fetch the
33-
workspace configuration. Same as on Xano interface.
34-
--branch <branch> The branch name. This is used to select the branch
35-
configuration. Same as on Xano Interface.
31+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
32+
provided at the setup command.
33+
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on
34+
Xano interface.
35+
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
36+
Interface.
3637
--group <name> API group name. Same as on Xano Interface.
37-
--all Regenerate for all API groups in the workspace /
38-
branch of the current context.
38+
--all Regenerate for all API groups in the workspace / branch of the current context.
3939
--print-output-dir Expose usable output path for further reuse.
4040
-h, --help display help for command
4141
```

‎docs/commands/generate-repo.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# generate-repo
2+
>[!NOTE|label:Description]
23
> #### Process Xano workspace into repo structure
34
4-
```sh
5-
xano generate-repo [options]
5+
```term
6+
$ xano generate-repo [options]
67
```
78
### Options
89

@@ -22,23 +23,22 @@ xano generate-repo [options]
2223
**Description:** Specify this if you want to fetch the workspace schema from Xano
2324

2425
### generate-repo --help
25-
```sh
26+
```term
27+
$ xano generate-repo --help
2628
Usage: xano generate-repo [options]
2729
2830
Process Xano workspace into repo structure
2931
3032
Options:
3133
--input <file> workspace yaml file
3234
--output <dir> output directory (overrides config)
33-
--instance <instance> The instance name. This is used to fetch the instance
34-
configuration. The value provided at the setup
35-
command.
36-
--workspace <workspace> The workspace name. This is used to fetch the
37-
workspace configuration. Same as on Xano interface.
38-
--branch <branch> The branch name. This is used to select the branch
39-
configuration. Same as on Xano Interface.
35+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
36+
provided at the setup command.
37+
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on
38+
Xano interface.
39+
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
40+
Interface.
4041
--print-output-dir Expose usable output path for further reuse.
41-
--fetch Specify this if you want to fetch the workspace
42-
schema from Xano
42+
--fetch Specify this if you want to fetch the workspace schema from Xano
4343
-h, --help display help for command
4444
```

‎docs/commands/generate-xs-repo.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# generate-xs-repo
2+
>[!NOTE|label:Description]
23
> #### Process Xano workspace into repo structure
34
4-
```sh
5-
xano generate-xs-repo [options]
5+
```term
6+
$ xano generate-xs-repo [options]
67
```
78
### Options
89

@@ -16,19 +17,19 @@ xano generate-xs-repo [options]
1617
**Description:** Expose usable output path for further reuse.
1718

1819
### generate-xs-repo --help
19-
```sh
20+
```term
21+
$ xano generate-xs-repo --help
2022
Usage: xano generate-xs-repo [options]
2123
2224
Process Xano workspace into repo structure
2325
2426
Options:
25-
--instance <instance> The instance name. This is used to fetch the instance
26-
configuration. The value provided at the setup
27-
command.
28-
--workspace <workspace> The workspace name. This is used to fetch the
29-
workspace configuration. Same as on Xano interface.
30-
--branch <branch> The branch name. This is used to select the branch
31-
configuration. Same as on Xano Interface.
27+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
28+
provided at the setup command.
29+
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on
30+
Xano interface.
31+
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
32+
Interface.
3233
--print-output-dir Expose usable output path for further reuse.
3334
-h, --help display help for command
3435
```

‎docs/commands/registry-add.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# registry-add
2+
>[!NOTE|label:Description]
23
> #### Add a prebuilt component to the current Xano context.
34
4-
```sh
5-
xano registry-add [options]
5+
```term
6+
$ xano registry-add [options]
67
```
78
### Options
89

@@ -18,21 +19,20 @@ xano registry-add [options]
1819
**Description:** URL to the component registry. Default: http://localhost:5500/registry/definitions
1920

2021
### registry-add --help
21-
```sh
22+
```term
23+
$ xano registry-add --help
2224
Usage: xano registry-add [options]
2325
2426
Add a prebuilt component to the current Xano context.
2527
2628
Options:
27-
--instance <instance> The instance name. This is used to fetch the instance
28-
configuration. The value provided at the setup
29-
command.
30-
--workspace <workspace> The workspace name. This is used to fetch the
31-
workspace configuration. Same as on Xano interface.
32-
--branch <branch> The branch name. This is used to select the branch
33-
configuration. Same as on Xano Interface.
29+
--instance <instance> The instance name. This is used to fetch the instance configuration. The value
30+
provided at the setup command.
31+
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on
32+
Xano interface.
33+
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano
34+
Interface.
3435
--components Comma-separated list of components to add
35-
--registry <url> URL to the component registry. Default:
36-
http://localhost:5500/registry/definitions
36+
--registry <url> URL to the component registry. Default: http://localhost:5500/registry/definitions
3737
-h, --help display help for command
3838
```

0 commit comments

Comments
 (0)