docs: Update API reference documentation to incorporate scalar implementation

This commit introduces enhancements to the API reference documentation by implementing a scalar feature. The changes encompass both the user interface (UI) and functionality aspects, ensuring better clarity and usability for users interacting with the API documentation.
This commit is contained in:
Arista Indrajaya 2024-03-14 10:06:46 +07:00
parent 7048c85465
commit 0da6c3ad89
3 changed files with 1200 additions and 9 deletions

View File

@ -113,7 +113,19 @@ const config = {
],
//To input custom Plugin
path.resolve(__dirname, 'plugins', 'changelog-plugin'),
// path.resolve(__dirname, 'plugins', 'changelog-plugin'),
[
'@scalar/docusaurus',
{
label: '',
route: '/api-reference',
configuration: {
spec: {
url: 'https://aindrajaya.github.io/openapi-spec/openapi.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: {

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