docs: api reference 2.0 (#2367)

docs: api reference 2.0
This commit is contained in:
Henry 2024-03-15 18:49:56 +09:00 committed by GitHub
commit 60a3739576
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 3686 additions and 9 deletions

View File

@ -104,7 +104,7 @@ const config = {
{
from: "/troubleshooting/undefined-issue/",
to: "/guides/error-codes/undefined-issue/",
}, {
}, {
from: "/install/",
to: "/guides/install/",
},
@ -114,6 +114,18 @@ const config = {
//To input custom Plugin
path.resolve(__dirname, 'plugins', 'changelog-plugin'),
[
'@scalar/docusaurus',
{
label: '',
route: '/api-reference',
configuration: {
spec: {
url: 'https://raw.githubusercontent.com/janhq/jan/dev/docs/openapi/jan.json',
},
},
},
],
],
// The classic preset will relay each option entry to the respective sub plugin/theme.
@ -160,7 +172,7 @@ const config = {
specs: [
{
spec: "openapi/jan.yaml", // can be local file, url, or parsed json object
route: "/api-reference/", // path where to render docs
route: "/api-reference-1.0/", // path where to render docs
},
],
theme: {

2486
docs/openapi/jan.json Normal file

File diff suppressed because it is too large Load Diff

View File

@ -26,6 +26,7 @@
"@heroicons/react": "^2.0.18",
"@mdx-js/react": "^3.0.0",
"@redocly/cli": "^1.4.1",
"@scalar/docusaurus": "^0.1.3",
"autoprefixer": "^10.4.16",
"axios": "^1.5.1",
"clsx": "^1.2.1",

File diff suppressed because it is too large Load Diff