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

jsdoc2vitepress

v1.0.5

Published

Generates vitepress API documentation from jsdoc annotated source code.

Downloads

12

Vulnerabilities

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

Links

Git

Maintainers

luciozhangluciozhang

Keywords

jsdocvitepressapidocannotatedmarkdowm注释生成文档

Readme

NPM version NPM downloads NPM License

Generates vitepress API documentation from jsdoc annotated source code.

What you need is to write comments that conform to the jsdoc specification, and jsdoc2vitepress will help you generate API documentation by VitePress.

Install

npm install -D jsdoc2vitepress

Usage

Init docs directory

jsdoc2vitepress init
What will happen?

In local Directory

md目录

Start VitePress

Generates vitepress API documentation from jsdoc annotated source code and run Vitepress

jsdoc2vitepress start
What will happen?

In console

init&start

In local Directory

md目录

In Once of the Markdown

MD内容

Build VitePress

Generates vitepress API documentation from jsdoc annotated source code and build Vitepress

jsdoc2vitepress build
What will happen?

In console

构建网站

In local Directory

vitepress-dist

Website

文档网站

How it work

JS/TS annotated source code -> Markdown ->VitePress website

总体流程

See More detail in 注释生成文档太难看？试试用注释生成vitepress文档

License

MIT

Copyright (c) 2022-present, luciozhang