npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@paloaltonetworks/docusaurus-preset-openapi

v17.0.9

Published

OpenAPI preset for Docusaurus.

Downloads

22

Readme

OpenAPI plugin for generating API reference docs in Docusaurus v2.

Installation

Install the preset in your docusaurus project by running:

// with npm
npm install docusaurus-preset-openapi

// with yarn
yarn add docusaurus-preset-openapi

Usage

  1. Add your OpenAPI definition to the root of your site dir as openapi.json (See Configuration options below).

  2. The OpenAPI preset can be used as a drop-in replacement for @docusaurus/preset-classic, replace it as follows:

    /* docusaurus.config.js */
    
    {
      presets: [
        [
          "docusaurus-preset-openapi",
          {
            // docs: { ... },
            // blogs: { ... },
            // theme: { ... },
          },
        ],
      ],
    }
  3. Add a link to the API section of your site by updating themeConfig.navbar.items:

    /* docusaurus.config.js */
    
    {
      themeConfig: {
        navbar: {
          items: [
            // ... other items
            { to: "/api", label: "API", position: "left" },
            // ... other items
          ],
        },
      },
    }

Configuration

The OpenAPI plugin can be configured with the following options:

| Name | Type | Default | Description | | ---------------------------- | --------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------- | | path | string | 'openapi.json' | Path to OpenAPI definition (json or yaml) on filesystem relative to site dir. | | routeBasePath | string | 'api' | URL route for the API section of your site. DO NOT include a trailing slash. Use / for shipping API without base path. | | sidebarCollapsible | boolean | true | Whether sidebar categories are collapsible by default. | | sidebarCollapsed | boolean | true | Whether sidebar categories are collapsed by default. | | apiLayoutComponent | string | '@theme/ApiPage' | Root Layout component of each API page. | | apiItemComponent | string | '@theme/ApiItem' | Main API container, with demo panel, pagination, etc. | | remarkPlugins | any[] | [] | Remark plugins passed to MDX. | | rehypePlugins | any[] | [] | Rehype plugins passed to MDX. | | beforeDefaultRemarkPlugins | any[] | [] | Custom Remark plugins passed to MDX before the default Docusaurus Remark plugins. | | beforeDefaultRehypePlugins | any[] | [] | Custom Rehype plugins passed to MDX before the default Docusaurus Rehype plugins. |

Example:

/* docusaurus.config.js */

{
  presets: [
    [
      "docusaurus-preset-openapi",
      {
        api: {
          path: "api/cars.yaml",
          routeBasePath: "cars",
          // ... other options
        }
      },
    ],
  ],
}