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

@videjs/doc-parser

v0.0.2-development

Published

Parse Vide documentation into a machine readable JSON file.

Downloads

2

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

hyperiondeveloperhyperiondeveloper

Keywords

videdocsdocumentationapitypescript.d.tsdefinitions

Readme

Vide Docs Parser

Generate a structured JSON API file from Vide's free-form documentation

Usage

yarn global add @videjs/docs-parser
cd ~/projects/path/to/Vide/repo
videjs-docs-parser --dir ./

# You now have ./vide-api.json with the entire Vide API

Options:

  • --useReadme - Assume all documentation is in the module's base README.md file
  • --dir - The base directory where documentation is located.
    • API documentation must be located in /docs/api within the specified base directory.
    • API structures documentation must be located in /docs/api/structures within the specified base directory.
  • --packageMode - Can be single or multi; default single. Specifying multi allows exporting multiple packages from an API instead of multiple modules from a single package.

TypeScript Definitions

The output of this module is used to generate TypeScript definitions for the Vide API. This module itself is not used to generate those definitions - @Vide/typescript-definitions is.

Further, if you're looking for tooling that automatically surfaces typings in GitHub PRs, you're probably looking for Archaeologist.

License

MIT