Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scalar api refs #526

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import {themes as prismThemes} from'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
import {EnumChangefreq} from "sitemap";
import {ScalarOptions} from "@scalar/docusaurus";

const config: Config = {
title: 'Pieces for Developers',
Expand Down Expand Up @@ -50,6 +51,39 @@ const config: Config = {
],
],

plugins: [
[
'@scalar/docusaurus',
{
id: 'scalar-apis',
label: 'APIs',
route: '/build/reference/apis',
showNavLink: false,
configuration: {
spec: {
url: 'https://raw.githubusercontent.com/pieces-app/pieces-os-client-openapi-spec/main/spec/modules/core/isomorphic.openapi.yaml',
},
hideDownloadButton: true,
},
} as ScalarOptions,
],
[
'@scalar/docusaurus',
{
id: 'scalar-models',
label: 'Models',
route: '/build/reference/models',
showNavLink: false,
configuration: {
spec: {
url: 'https://raw.githubusercontent.com/pieces-app/pieces-os-client-openapi-spec/main/spec/common/runtime_common_library.yaml',
},
hideDownloadButton: true,
},
} as ScalarOptions,
]
],

themeConfig: {
image: 'assets/pfd_preview.png',
metadata: [
Expand Down
21 changes: 11 additions & 10 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "documentation",
"version": "2.0.0",
"private": true,
"private": false,
"scripts": {
"start": "docusaurus start",
"prebuild": "python3 docs/build/glossary/sort.py && node docs/build/glossary/compile-glossary.js",
Expand All @@ -12,12 +12,13 @@
"typecheck": "tsc"
},
"dependencies": {
"@docusaurus/core": "^3.3.2",
"@docusaurus/plugin-google-tag-manager": "^3.3.2",
"@docusaurus/preset-classic": "^3.3.2",
"@docusaurus/theme-classic": "^3.3.2",
"@docusaurus/theme-common": "^3.3.2",
"@docusaurus/core": "^3.4.0",
"@docusaurus/plugin-google-tag-manager": "^3.4.0",
"@docusaurus/preset-classic": "^3.4.0",
"@docusaurus/theme-classic": "^3.4.0",
"@docusaurus/theme-common": "^3.4.0",
"@mdx-js/react": "^3.0.0",
"@scalar/docusaurus": "^0.4.84",
"@typeform/embed-react": "^3.17.0",
"clsx": "^2.0.0",
"docusaurus-lunr-search": "^3.3.2",
Expand All @@ -27,10 +28,10 @@
"react-dom": "^18.0.0"
},
"devDependencies": {
"@docusaurus/eslint-plugin": "^3.3.2",
"@docusaurus/module-type-aliases": "^3.3.2",
"@docusaurus/tsconfig": "^3.3.2",
"@docusaurus/types": "^3.3.2",
"@docusaurus/eslint-plugin": "^3.4.0",
"@docusaurus/module-type-aliases": "^3.4.0",
"@docusaurus/tsconfig": "^3.4.0",
"@docusaurus/types": "^3.4.0",
"@types/node": "^20.11.26",
"@types/react": "^18.3.2",
"sitemap": "^7.1.1",
Expand Down
Loading