Changelog #019

Mar 8th, 2024 - Docusaurus Integration

Community Contributors ✨

We wanted to give a shoutout to the open-source contributors who shipped some great work on the Open-Source repository:

Amorim33 - fix: define color-scheme to improve request client selector readability (#1126)

Stoked to see this in production and bettering the Scalar API References ✨

Docusaurus Integration

One of our most requested features was to integrate Scalar with Docusaurus, and today we have that integration live! To get started all you need to do is install the package

npm install @scalar/docusaurus

and add this to your docusaurus.config.js!

import type { ScalarOptions } from '@scalar/docusaurus'

plugins: [
  [
    '@scalar/docusaurus',
    {
      label: 'Scalar',
      route: '/scalar',
      configuration: {
        spec: {
          url: 'https://petstore3.swagger.io/api/v3/openapi.json',
        },
      },
    } as ScalarOptions,
  ],
],

Now you have scalar in docusaurus 🦕!

One of our most requested features was to integrate Scalar with Docusaurus, and today we have that integration live!

Scalar API Reference React

We also shipped a new package for the Scalar API References that integrates smoothly with React projects. Which was needed for our Docusaurus integration!

npm install @scalar/api-reference-react

And you can use it just like the vue component 🥳

import { ApiReferenceReact } from '@scalar/api-reference-react'
import React from 'react'

function App() {
  return (
    <ApiReferenceReact/>
  )
}

export default App

Fixes & Improvements

So much work was put into smaller improvements + UX of our app, all the small details make the world of difference ✨

feat: added docusaurus plugin (#1133)
fix: add deprecated path to classic layout (#1134)
fix: duplicate border top (#1135)
feat: add new client only api reference wrapper for react (#1132)
chore: update to typescript 5.4 (#1127)
feat: API references composition (#1123)
fix: move components css back to js so import of css file no longer required
fix: define color-scheme to improve request client selector readability (#1126)
fix: scope scrollbar styles (#1081)
fix: custom operation security scheme list is ignored, fix #1112 (#1115)
chore: remove preparsed content configuration (#1113)
fix: change client library colours to be variables (#1106)
fix: content not reactive (#1114)
fix: deprecated operations are not striked through, fix #1104 (#1116)
fix: proxy url prop (#1110)
feat: add proxy as prop to react client (#1108)
chore: improve the contributor experience (#1096)
fix: style of references from revert (#1102)
fix: revert css injection (#1100)
fix: mobile header button fix (#1098)

We are incredibly grateful for the Scalar community, all the feedback has been truly inspiring, helps guide us to prioritize fixes and we are looking forward to releasing more features and fixes for the next changelog ✨

Join us:

Marc

CEO & Co-Founder, Scalar