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

redocusaurus

v2.1.2

Published

Redoc for DocusaurusV2

Downloads

79,755

Readme

Redocusaurus

npm

Redoc for Docusaurus.

Usage

  1. Setup docusaurus project

  2. Install redocusaurus:

yarn add redocusaurus
# OR
pnpm add redocusaurus
# OR
npm i --save redocusaurus
  1. Add it as a preset to your docusaurus config along with @docusaurus/preset-classic and pass options:

    // docusaurus.config.ts
    import type { Config } from '@docusaurus/types';
    import type * as Preset from '@docusaurus/preset-classic';
    import type * as Redocusaurus from 'redocusaurus';
    
    const config: Config = {
      // ...
      presets: [
        // .. Your other presets' config
        [
         '@docusaurus/preset-classic',
          {
            googleAnalytics: {
              trackingID: 'XXXXXX',
            },
          } satisfies Preset.Options,
        ]
        // Redocusaurus config
        [
          'redocusaurus',
          {
            // Plugin Options for loading OpenAPI files
            specs: [
              // Pass it a path to a local OpenAPI YAML file
              {
                // Redocusaurus will automatically bundle your spec into a single file during the build
                spec: 'openapi/index.yaml',
                route: '/api/',
              },
              // You can also pass it a OpenAPI spec URL
              {
                spec: 'https://redocly.github.io/redoc/openapi.yaml',
                route: '/openapi/',
              },
            ],
            // Theme Options for modifying how redoc renders them
            theme: {
              // Change with your site colors
              primaryColor: '#1890ff',
            },
          },
        ] satisfies Redocusaurus.PresetEntry,
      ],
      // ... Rest of your config
    };
    
    export default config;

The API Doc will be available at the route specified (/api/ in the example above). To customize it see full plugin options.

Options

specs

Pass it an array of plugin options, see docusaurus-plugin-redoc for individual option details.

theme

Pass options to customize the theme, see docusaurus-theme-redoc for individual option details.

Docs

See: https://redocusaurus.vercel.app/docs