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

pwa-devdocs

v13.3.1

Published

A documentation site for Magento PWA

Downloads

1

Readme

pwa-devdocs

This is the source code and documentation repository for the PWA Studios documentation site.

The PWA DevDocs site is build using Jekyll and hosted using GitHub Pages.

Getting Started

Use the following instructions to build a local instance of the documentation.

Prerequisites

Installation

  1. Clone the PWA Studio repository. If you want to contribute, fork the repository and clone from your fork.
  2. Change into the PWA Studio project root using the following command:
    cd pwa-studio
  3. Change into the pwa-devdocs directory using the following command:
    cd pwa-devdocs
  4. Run the following command to install the required node modules for the project:
    npm install
  5. Run the following command to install the required Ruby libraries:
    bundle install

Build site

In the pwa-devdocs directory, run the following command to build and run the site locally:

npm start

If you just want to generate the HTML pages in the _site folder, run the following command:

npm run build

Testing

npm run lint

This command runs linting on the documentation to make sure it meets our standards.

To test a single file append the markdown file at the end of the lint command.

Example:

npm run lint -- src/technologies/versioning/index.md

Contributing

This is an open source project that welcomes contributors of all skill levels.

If you want to contribute, please review the contribution guidelines and follow our code of conduct.

License

This project is licensed under OSL-3.0 - see the LICENSE.txt file for details.