0.4.134 • Published 8 months ago

@scalar/docusaurus v0.4.134

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

Scalar Docusaurus API Reference Plugin "Scalasaurus"

Version Downloads License Discord

scalasaurus

Installation

npm install @scalar/docusaurus

Usage

Simply add to the plugins section of your Docusaurus config. If you are using Typescript you can import the type options type as well.

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

plugins: [
  [
    '@scalar/docusaurus',
    {
      label: 'Scalar',
      route: '/scalar',
      showNavLink: true, // optional, default is true
      configuration: {
        spec: {
          url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml',
        },
      },
    } as ScalarOptions,
  ],
],

We wrote a detailed integration guide for Docusaurus.

Multiple API descriptions

Is it possible to show multiple API descriptions? Yes, it is! :)

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

plugins: [
  // First API definition
  [
    '@scalar/docusaurus',
    {
      // the `id` is required if you have multiple instances of the @scalar/docusaurus plugin
      id: 'scalar/galaxy',
      label: 'Scalar',
      route: '/scalar',
      showNavLink: true, // optional, default is true
      configuration: {
        spec: {
          url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
        },
      },
    } as ScalarOptions,
  ],
  // Second API definition
  [
    '@scalar/docusaurus',
    {
      // the `id` is required if you have multiple instances of the @scalar/docusaurus plugin
      id: 'petstore',
      label: 'Petstore',
      route: '/petstore',
      showNavLink: true, // optional, default is true
      configuration: {
        spec: {
          url: 'https://petstore3.swagger.io/api/v3/openapi.json',
        },
      },
    } as ScalarOptions,
  ],
],

Example

You can find an example in this repo under examples/docusaurus

Config

These configuration options are a WIP as this plugin is still in beta

label: string

The label on the nav bar for this route

route: string

Path at which the API Reference will be shown

configuration: ReferenceProps

You can find the full configuration options under packages/api-reference minus theme.

Community

We are API nerds. You too? Let’s chat on Discord: https://discord.gg/scalar

License

The source code in this repository is licensed under MIT.

apiclientdocusauruspostman alternativeresttestingreact
@scalar/api-reference-react
0.4.134

8 months ago

0.4.133

8 months ago

0.4.129

8 months ago

0.4.131

8 months ago

0.4.130

8 months ago

0.4.132

8 months ago

0.4.128

8 months ago

0.4.127

8 months ago

0.4.126

8 months ago

0.4.125

8 months ago

0.4.119

8 months ago

0.4.118

8 months ago

0.4.120

8 months ago

0.4.124

8 months ago

0.4.123

8 months ago

0.4.122

8 months ago

0.4.121

8 months ago

0.4.117

8 months ago

0.4.116

8 months ago

0.4.115

8 months ago

0.4.102

9 months ago

0.4.101

9 months ago

0.4.100

9 months ago

0.4.106

9 months ago

0.4.105

9 months ago

0.4.104

9 months ago

0.4.103

9 months ago

0.4.109

9 months ago

0.4.98

9 months ago

0.4.108

9 months ago

0.4.107

9 months ago

0.4.99

9 months ago

0.4.113

8 months ago

0.4.112

8 months ago

0.4.111

9 months ago

0.4.110

9 months ago

0.4.114

8 months ago

0.4.97

9 months ago

0.4.95

9 months ago

0.4.96

9 months ago

0.4.94

9 months ago

0.4.91

9 months ago

0.4.92

9 months ago

0.4.90

9 months ago

0.4.88

10 months ago

0.4.89

9 months ago

0.4.87

10 months ago

0.4.42

12 months ago

0.4.43

12 months ago

0.4.40

12 months ago

0.4.41

12 months ago

0.4.9

1 year ago

0.4.8

1 year ago

0.4.48

11 months ago

0.4.49

11 months ago

0.4.46

11 months ago

0.4.44

12 months ago

0.4.45

11 months ago

0.4.31

12 months ago

0.4.30

12 months ago

0.4.39

12 months ago

0.4.37

12 months ago

0.4.38

12 months ago

0.4.35

12 months ago

0.4.36

12 months ago

0.4.33

12 months ago

0.4.34

12 months ago

0.3.0

1 year ago

0.3.5

1 year ago

0.3.2

1 year ago

0.3.1

1 year ago

0.3.4

1 year ago

0.3.3

1 year ago

0.4.20

12 months ago

0.4.21

12 months ago

0.4.28

12 months ago

0.4.29

12 months ago

0.4.26

12 months ago

0.4.27

12 months ago

0.4.24

12 months ago

0.4.25

12 months ago

0.4.23

12 months ago

0.4.19

12 months ago

0.4.10

1 year ago

0.4.17

12 months ago

0.4.15

1 year ago

0.4.16

1 year ago

0.4.13

1 year ago

0.4.11

1 year ago

0.4.12

1 year ago

0.4.5

1 year ago

0.4.4

1 year ago

0.4.6

1 year ago

0.4.1

1 year ago

0.4.0

1 year ago

0.4.3

1 year ago

0.4.2

1 year ago

0.4.84

10 months ago

0.4.85

10 months ago

0.4.82

10 months ago

0.4.83

10 months ago

0.4.80

10 months ago

0.4.81

10 months ago

0.4.75

10 months ago

0.2.52

1 year ago

0.4.76

10 months ago

0.2.51

1 year ago

0.4.73

11 months ago

0.2.50

1 year ago

0.4.74

11 months ago

0.4.71

11 months ago

0.4.72

11 months ago

0.4.70

11 months ago

0.4.79

10 months ago

0.2.56

1 year ago

0.2.55

1 year ago

0.4.77

10 months ago

0.2.54

1 year ago

0.4.78

10 months ago

0.2.53

1 year ago

0.4.64

11 months ago

0.4.65

11 months ago

0.4.62

11 months ago

0.4.63

11 months ago

0.4.60

11 months ago

0.4.61

11 months ago

0.2.49

1 year ago

0.2.48

1 year ago

0.2.47

1 year ago

0.2.46

1 year ago

0.4.68

11 months ago

0.2.45

1 year ago

0.4.69

11 months ago

0.2.44

1 year ago

0.4.66

11 months ago

0.4.67

11 months ago

0.4.53

11 months ago

0.4.54

11 months ago

0.4.51

11 months ago

0.4.52

11 months ago

0.4.50

11 months ago

0.4.59

11 months ago

0.4.57

11 months ago

0.4.58

11 months ago

0.4.55

11 months ago

0.4.56

11 months ago

0.2.43

1 year ago

0.2.42

1 year ago

0.2.41

1 year ago

0.2.40

1 year ago

0.2.39

1 year ago

0.2.38

1 year ago

0.2.37

1 year ago

0.2.36

1 year ago

0.2.35

1 year ago

0.2.34

1 year ago

0.2.33

1 year ago

0.2.32

1 year ago

0.2.31

1 year ago

0.2.30

1 year ago

0.2.29

1 year ago

0.2.27

1 year ago

0.2.28

1 year ago

0.2.26

1 year ago

0.2.25

1 year ago

0.2.24

1 year ago

0.2.20

1 year ago

0.2.19

1 year ago

0.2.18

1 year ago

0.2.17

1 year ago

0.2.16

1 year ago

0.2.15

1 year ago

0.2.14

1 year ago

0.2.13

1 year ago

0.2.12

1 year ago

0.2.11

1 year ago

0.2.10

1 year ago

0.2.7

1 year ago

0.2.9

1 year ago

0.2.8

1 year ago

0.2.6

1 year ago

0.2.5

1 year ago

0.2.4

1 year ago

0.2.1

1 year ago

0.2.0

1 year ago

0.2.3

1 year ago

0.2.2

1 year ago

0.1.41

1 year ago

0.1.40

1 year ago

0.1.39

1 year ago

0.1.37

1 year ago

0.1.38

1 year ago

0.1.34

1 year ago

0.1.35

1 year ago

0.1.36

1 year ago

0.1.33

1 year ago

0.1.32

1 year ago

0.1.30

1 year ago

0.1.31

1 year ago

0.1.28

1 year ago

0.1.29

1 year ago

0.1.27

1 year ago

0.1.23

1 year ago

0.1.24

1 year ago

0.1.25

1 year ago

0.1.26

1 year ago

0.1.22

1 year ago

0.1.21

1 year ago

0.1.20

1 year ago

0.1.19

1 year ago

0.1.18

1 year ago

0.1.16

1 year ago

0.1.17

1 year ago

0.1.15

1 year ago

0.1.10

1 year ago

0.1.11

1 year ago

0.1.12

1 year ago

0.1.13

1 year ago

0.1.9

1 year ago

0.1.8

1 year ago

0.1.7

1 year ago

0.1.6

1 year ago

0.1.4

1 year ago

0.1.5

1 year ago

0.1.2

1 year ago

0.1.1

1 year ago

0.1.3

1 year ago

0.0.7

1 year ago

0.0.5

1 year ago

0.0.6

1 year ago

0.0.3

1 year ago

0.0.2

1 year ago