0.7.2 • Published 8 months ago

@scalar/docusaurus v0.7.2

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: {
        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: {
        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: {
        url: 'https://petstore3.swagger.io/api/v3/openapi.json',
      },
    } as ScalarOptions,
  ],
],

Example

You can find an example in this repo under integrations/docusaurus/playground

Run the example using

npm run playground

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/types
0.5.10

10 months ago

0.5.11

10 months ago

0.5.18

10 months ago

0.5.19

10 months ago

0.5.16

10 months ago

0.5.17

10 months ago

0.5.14

10 months ago

0.5.15

10 months ago

0.5.12

10 months ago

0.5.13

10 months ago

0.7.2

8 months ago

0.7.1

8 months ago

0.4.193

12 months ago

0.4.192

12 months ago

0.4.191

12 months ago

0.4.190

12 months ago

0.4.197

11 months ago

0.4.196

12 months ago

0.4.194

12 months ago

0.4.199

11 months ago

0.4.198

11 months ago

0.6.7

8 months ago

0.6.6

9 months ago

0.4.209

11 months ago

0.4.208

11 months ago

0.4.206

11 months ago

0.5.4

10 months ago

0.5.3

11 months ago

0.4.211

11 months ago

0.5.6

10 months ago

0.4.210

11 months ago

0.5.5

10 months ago

0.5.2

11 months ago

0.5.1

11 months ago

0.4.201

11 months ago

0.4.200

11 months ago

0.4.205

11 months ago

0.4.204

11 months ago

0.4.203

11 months ago

0.4.202

11 months ago

0.5.21

9 months ago

0.5.22

9 months ago

0.5.20

9 months ago

0.5.23

9 months ago

0.6.3

9 months ago

0.6.2

9 months ago

0.6.5

9 months ago

0.6.4

9 months ago

0.6.1

9 months ago

0.6.0

9 months ago

0.4.142

1 year ago

0.4.141

1 year ago

0.4.140

1 year ago

0.4.146

1 year ago

0.4.145

1 year ago

0.4.144

1 year ago

0.4.143

1 year ago

0.4.149

1 year ago

0.4.148

1 year ago

0.4.147

1 year ago

0.4.135

1 year ago

0.4.139

1 year ago

0.4.138

1 year ago

0.4.137

1 year ago

0.4.136

1 year ago

0.5.8

10 months ago

0.5.7

10 months ago

0.5.9

10 months ago

0.4.182

1 year ago

0.4.181

1 year ago

0.4.180

1 year ago

0.4.186

1 year ago

0.4.184

1 year ago

0.4.183

1 year ago

0.4.189

12 months ago

0.4.188

12 months ago

0.4.187

12 months ago

0.4.171

1 year ago

0.4.170

1 year ago

0.4.174

1 year ago

0.4.173

1 year ago

0.4.172

1 year ago

0.4.179

1 year ago

0.4.178

1 year ago

0.4.177

1 year ago

0.4.176

1 year ago

0.4.160

1 year ago

0.4.164

1 year ago

0.4.161

1 year ago

0.4.168

1 year ago

0.4.167

1 year ago

0.4.166

1 year ago

0.4.165

1 year ago

0.4.169

1 year ago

0.4.153

1 year ago

0.4.152

1 year ago

0.4.150

1 year ago

0.4.157

1 year ago

0.4.156

1 year ago

0.4.155

1 year ago

0.4.154

1 year ago

0.4.159

1 year ago

0.4.158

1 year ago

0.4.134

1 year ago

0.4.133

1 year ago

0.4.129

1 year ago

0.4.131

1 year ago

0.4.130

1 year ago

0.4.132

1 year ago

0.4.128

1 year ago

0.4.127

1 year ago

0.4.126

1 year ago

0.4.125

1 year ago

0.4.119

1 year ago

0.4.118

1 year ago

0.4.120

1 year ago

0.4.124

1 year ago

0.4.123

1 year ago

0.4.122

1 year ago

0.4.121

1 year ago

0.4.117

1 year ago

0.4.116

1 year ago

0.4.115

1 year ago

0.4.102

1 year ago

0.4.101

1 year ago

0.4.100

1 year ago

0.4.106

1 year ago

0.4.105

1 year ago

0.4.104

1 year ago

0.4.103

1 year ago

0.4.109

1 year ago

0.4.98

1 year ago

0.4.108

1 year ago

0.4.107

1 year ago

0.4.99

1 year ago

0.4.113

1 year ago

0.4.112

1 year ago

0.4.111

1 year ago

0.4.110

1 year ago

0.4.114

1 year ago

0.4.97

1 year ago

0.4.95

1 year ago

0.4.96

1 year ago

0.4.94

1 year ago

0.4.91

1 year ago

0.4.92

1 year ago

0.4.90

1 year ago

0.4.88

1 year ago

0.4.89

1 year ago

0.4.87

1 year ago

0.4.42

2 years ago

0.4.43

2 years ago

0.4.40

2 years ago

0.4.41

2 years ago

0.4.9

2 years ago

0.4.8

2 years ago

0.4.48

2 years ago

0.4.49

2 years ago

0.4.46

2 years ago

0.4.44

2 years ago

0.4.45

2 years ago

0.4.31

2 years ago

0.4.30

2 years ago

0.4.39

2 years ago

0.4.37

2 years ago

0.4.38

2 years ago

0.4.35

2 years ago

0.4.36

2 years ago

0.4.33

2 years ago

0.4.34

2 years ago

0.3.0

2 years ago

0.3.5

2 years ago

0.3.2

2 years ago

0.3.1

2 years ago

0.3.4

2 years ago

0.3.3

2 years ago

0.4.20

2 years ago

0.4.21

2 years ago

0.4.28

2 years ago

0.4.29

2 years ago

0.4.26

2 years ago

0.4.27

2 years ago

0.4.24

2 years ago

0.4.25

2 years ago

0.4.23

2 years ago

0.4.19

2 years ago

0.4.10

2 years ago

0.4.17

2 years ago

0.4.15

2 years ago

0.4.16

2 years ago

0.4.13

2 years ago

0.4.11

2 years ago

0.4.12

2 years ago

0.4.5

2 years ago

0.4.4

2 years ago

0.4.6

2 years ago

0.4.1

2 years ago

0.4.0

2 years ago

0.4.3

2 years ago

0.4.2

2 years ago

0.4.84

1 year ago

0.4.85

1 year ago

0.4.82

1 year ago

0.4.83

1 year ago

0.4.80

1 year ago

0.4.81

1 year ago

0.4.75

1 year ago

0.2.52

2 years ago

0.4.76

1 year ago

0.2.51

2 years ago

0.4.73

1 year ago

0.2.50

2 years ago

0.4.74

1 year ago

0.4.71

1 year ago

0.4.72

1 year ago

0.4.70

1 year ago

0.4.79

1 year ago

0.2.56

2 years ago

0.2.55

2 years ago

0.4.77

1 year ago

0.2.54

2 years ago

0.4.78

1 year ago

0.2.53

2 years ago

0.4.64

1 year ago

0.4.65

1 year ago

0.4.62

1 year ago

0.4.63

1 year ago

0.4.60

1 year ago

0.4.61

1 year ago

0.2.49

2 years ago

0.2.48

2 years ago

0.2.47

2 years ago

0.2.46

2 years ago

0.4.68

1 year ago

0.2.45

2 years ago

0.4.69

1 year ago

0.2.44

2 years ago

0.4.66

1 year ago

0.4.67

1 year ago

0.4.53

2 years ago

0.4.54

2 years ago

0.4.51

2 years ago

0.4.52

2 years ago

0.4.50

2 years ago

0.4.59

1 year ago

0.4.57

2 years ago

0.4.58

1 year ago

0.4.55

2 years ago

0.4.56

2 years ago

0.2.43

2 years ago

0.2.42

2 years ago

0.2.41

2 years ago

0.2.40

2 years ago

0.2.39

2 years ago

0.2.38

2 years ago

0.2.37

2 years ago

0.2.36

2 years ago

0.2.35

2 years ago

0.2.34

2 years ago

0.2.33

2 years ago

0.2.32

2 years ago

0.2.31

2 years ago

0.2.30

2 years ago

0.2.29

2 years ago

0.2.27

2 years ago

0.2.28

2 years ago

0.2.26

2 years ago

0.2.25

2 years ago

0.2.24

2 years ago

0.2.20

2 years ago

0.2.19

2 years ago

0.2.18

2 years ago

0.2.17

2 years ago

0.2.16

2 years ago

0.2.15

2 years ago

0.2.14

2 years ago

0.2.13

2 years ago

0.2.12

2 years ago

0.2.11

2 years ago

0.2.10

2 years ago

0.2.7

2 years ago

0.2.9

2 years ago

0.2.8

2 years ago

0.2.6

2 years ago

0.2.5

2 years ago

0.2.4

2 years ago

0.2.1

2 years ago

0.2.0

2 years ago

0.2.3

2 years ago

0.2.2

2 years ago

0.1.41

2 years ago

0.1.40

2 years ago

0.1.39

2 years ago

0.1.37

2 years ago

0.1.38

2 years ago

0.1.34

2 years ago

0.1.35

2 years ago

0.1.36

2 years ago

0.1.33

2 years ago

0.1.32

2 years ago

0.1.30

2 years ago

0.1.31

2 years ago

0.1.28

2 years ago

0.1.29

2 years ago

0.1.27

2 years ago

0.1.23

2 years ago

0.1.24

2 years ago

0.1.25

2 years ago

0.1.26

2 years ago

0.1.22

2 years ago

0.1.21

2 years ago

0.1.20

2 years ago

0.1.19

2 years ago

0.1.18

2 years ago

0.1.16

2 years ago

0.1.17

2 years ago

0.1.15

2 years ago

0.1.10

2 years ago

0.1.11

2 years ago

0.1.12

2 years ago

0.1.13

2 years ago

0.1.9

2 years ago

0.1.8

2 years ago

0.1.7

2 years ago

0.1.6

2 years ago

0.1.4

2 years ago

0.1.5

2 years ago

0.1.2

2 years ago

0.1.1

2 years ago

0.1.3

2 years ago

0.0.7

2 years ago

0.0.5

2 years ago

0.0.6

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago