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

@es-pkg/doc

v0.0.5

Published

根据ts文件的注释生成表格md

Downloads

4

Vulnerabilities

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

Links

Git

Maintainers

tspantspan

Keywords

es-pkg-doc

Readme

@es-pkg/doc

根据ts文件的注释生成表格md

NPM Version  NPM Version  unpacked size  Author

📦 Installation

npm install @es-pkg/doc

🏠 Exports

|参数|类型| |---|---| |🔖default|References| |🧷DocOptions|Type Aliases| |🎗️bootstrap|Functions|

🔖References

default

Renames and re-exports bootstrap

🧷Type Aliases

生成doc文档的配置项

DocOptions

|参数|类型|说明|默认值| |---|---|---|---| |author|?: string|作者|| |caseDir|?: string|生成用法 例子的目录|case| |desc|?: string|描述|| |entry|: string|编译文件的入口|| |keepHtmlTable|?: boolean|是否保留为原始htmlTable|false| |name|?: string|包名称|| |outDir|: string|编译后输出的文件夹|| |outName|?: string|编译后输出的文件名称|README| |outType|?: "html" | "md" | ["html", "md"]|编译后输出的类型|md| |repository|?: string|仓库地址|| |tsconfig|?: string|编译文件的 ts配置路径||

🎗️Functions

bootstrap

  • 默认 EsPkgDoc的主函数

  • bootstrap(config:DocOptions): Promise<void>