Skip to content

Commit c170317

Browse files
authored
feat: internal documentation building (#154)
2 parents 156d7cc + 1cd2eba commit c170317

31 files changed

+1212
-617
lines changed

.changeset/afraid-seals-crash.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@calycode/cli": patch
3+
---
4+
5+
chore: remove tailwind cdn from docs [#131](https://github.com/calycode/xano-tools/issues/131)

.changeset/upset-teeth-fetch.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
'@calycode/core': minor
3+
'@calycode/cli': minor
4+
---
5+
6+
feat: new command `generate-internal-docs` that creates a directory of docsfiy powered browseable documentation for your workspace rendered from markdown on client (Docsify)
7+
chore: update docs to include the new command

.changeset/wise-yaks-scream.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+
fix: fixing multiple issues with the generated markdown of the workspace, that was causing broken links

docs/commands/export-backup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ Usage: xano export-backup [options]
2424
Backup Xano Workspace via Metadata API
2525
2626
Options:
27-
--instance <instance> The instance name. This is used to fetch the instance
28-
configuration. The value provided at the setup
29-
command.
27+
--instance <instance> The instance name. This is used to fetch the
28+
instance configuration. The value provided at the
29+
setup command.
3030
--workspace <workspace> The workspace name. This is used to fetch the
3131
workspace configuration. Same as on Xano interface.
3232
--branch <branch> The branch name. This is used to select the branch

docs/commands/generate-code.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ $ xano generate-code --help
3232
Usage: xano generate-code [options]
3333
3434
Create a library based on the OpenAPI specification. If the openapi
35-
specification has not yet been generated, this will generate that as well as the
36-
first step.
35+
specification has not yet been generated, this will generate that as well as
36+
the first step.
3737
3838
Options:
39-
--instance <instance> The instance name. This is used to fetch the instance
40-
configuration. The value provided at the setup
41-
command.
39+
--instance <instance> The instance name. This is used to fetch the
40+
instance configuration. The value provided at the
41+
setup command.
4242
--workspace <workspace> The workspace name. This is used to fetch the
4343
workspace configuration. Same as on Xano interface.
4444
--branch <branch> The branch name. This is used to select the branch

docs/commands/generate-oas.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ Scalar API Reference. + this command brings the Swagger docs to OAS 3.1+
3131
version.
3232
3333
Options:
34-
--instance <instance> The instance name. This is used to fetch the instance
35-
configuration. The value provided at the setup
36-
command.
34+
--instance <instance> The instance name. This is used to fetch the
35+
instance configuration. The value provided at the
36+
setup command.
3737
--workspace <workspace> The workspace name. This is used to fetch the
3838
workspace configuration. Same as on Xano interface.
3939
--branch <branch> The branch name. This is used to select the branch

docs/commands/generate-repo.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,14 @@ API to offer the full details. However that is enriched with the Xanoscripts
3232
after Xano 2.0 release.
3333
3434
Options:
35-
-I, --input <file> Workspace yaml file from a local source, if present.
35+
-I, --input <file> Workspace yaml file from a local source, if
36+
present.
3637
-O, --output <dir> Output directory (overrides default config), useful
3738
when ran from a CI/CD pipeline and want to ensure
3839
consistent output location.
39-
--instance <instance> The instance name. This is used to fetch the instance
40-
configuration. The value provided at the setup
41-
command.
40+
--instance <instance> The instance name. This is used to fetch the
41+
instance configuration. The value provided at the
42+
setup command.
4243
--workspace <workspace> The workspace name. This is used to fetch the
4344
workspace configuration. Same as on Xano interface.
4445
--branch <branch> The branch name. This is used to select the branch

docs/commands/generate-xs-repo.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ $ xano generate-xs-repo [options]
2121
$ xano generate-xs-repo --help
2222
Usage: xano generate-xs-repo [options]
2323
24-
Process Xano workspace into repo structure. Supports table, function and apis as
25-
of know. Xano VSCode extension is the preferred solution over this command.
24+
Process Xano workspace into repo structure. Supports table, function and apis
25+
as of know. Xano VSCode extension is the preferred solution over this command.
2626
Outputs of this process are also included in the default repo generation
2727
command.
2828
2929
Options:
30-
--instance <instance> The instance name. This is used to fetch the instance
31-
configuration. The value provided at the setup
32-
command.
30+
--instance <instance> The instance name. This is used to fetch the
31+
instance configuration. The value provided at the
32+
setup command.
3333
--workspace <workspace> The workspace name. This is used to fetch the
3434
workspace configuration. Same as on Xano interface.
3535
--branch <branch> The branch name. This is used to select the branch

docs/commands/registry-add.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,17 @@ $ xano registry-add [options]
2121
$ xano registry-add --help
2222
Usage: xano registry-add [options] <components...>
2323
24-
Add a prebuilt component to the current Xano context, essentially by pushing an
25-
item from the registry to the Xano instance.
24+
Add a prebuilt component to the current Xano context, essentially by pushing
25+
an item from the registry to the Xano instance.
2626
2727
Arguments:
2828
components Space delimited list of components to add to your
2929
Xano instance.
3030
3131
Options:
32-
--instance <instance> The instance name. This is used to fetch the instance
33-
configuration. The value provided at the setup
34-
command.
32+
--instance <instance> The instance name. This is used to fetch the
33+
instance configuration. The value provided at the
34+
setup command.
3535
--workspace <workspace> The workspace name. This is used to fetch the
3636
workspace configuration. Same as on Xano interface.
3737
--branch <branch> The branch name. This is used to select the branch

docs/commands/registry-scaffold.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,15 @@ $ xano registry-scaffold --help
1818
Usage: xano registry-scaffold [options]
1919
2020
Scaffold a Xano registry folder with a sample component. Xano registry can be
21-
used to share and reuse prebuilt components. In the registry you have to follow
22-
the [registry](https://calycode.com/schemas/registry/registry.json) and
21+
used to share and reuse prebuilt components. In the registry you have to
22+
follow the [registry](https://calycode.com/schemas/registry/registry.json) and
2323
[registry item](https://calycode.com/schemas/registry/registry-item.json)
2424
schemas.
2525
2626
Options:
2727
--output <path> Local output path for the registry
2828
--instance <instance> The instance name. This is used to fetch the instance
29-
configuration. The value provided at the setup command.
29+
configuration. The value provided at the setup
30+
command.
3031
-h, --help display help for command
3132
```

0 commit comments

Comments
 (0)