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

@gasket/plugin-docusaurus

v7.0.6

Published

Gasket plugin for docusaurus

Downloads

466

Readme

@gasket/plugin-docusaurus

Use Docusaurus to serve a website view of the collated docs from @gasket/plugin-docs.

Installation

npm i @gasket/plugin-docs @gasket/plugin-docusaurus

Update your gasket file plugin configuration:

// gasket.js

+ import pluginDocusarus from '@gasket/plugin-docusaurus';
+ import pluginDocs from '@gasket/plugin-docs';

export default makeGasket({
  plugins: [
+   pluginDocs
+   pluginDocusarus
  ]
});

Now, when you run npx gasket docs in your app, a nice Docusaurus website will be launched in your browser.

Configuration

To be set under docusaurus in the gasket.js.

  • rootDir - (string) Root Docusaurus directory. Default is .docs.
  • docsDir - (string) Sub-directory for the generated markdown from the docs plugin. Default is docs.
  • port - (number) Port to serve the docs from. Default is 3000.
  • host - (string) Hostname to serve the docs from. Default is localhost.

Example

// gasket.js

 export default makeGasket({
  docusaurus: {
    rootDir: 'my-site-documents',
    docsDir: 'markdown',
    port: 8000,
    host: 'custom-host'
  }
});

// structure
gasket-app/ // app root
|_ my-site-documents // docusaurus root
  |_ .docusaurus // build folder
  |_ markdown // generated docs from @gasket/plugin-docs

docusaurus.config.js

A required docusaurus.config.js will generated in the root directory if one is not present. Docusaurus allows for additional configuration/customization options and you can define those directly in the docusaurus.config.js.

License

MIT