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

stencil-doc-generator

v1.0.1

Published

custom doc generator for stencil

Downloads

15

Readme

根据传入的模版来自定义生成doc

Install

npm install stencil-doc-generator -D

Usage

在stencil.config.ts中配置自定义文档输出:

{
  outputTargets:[
    {
      type: 'docs-custom',
      generator: generateCustomDoc({
        templatePath: './template.mdx',
        outputDir: 'docs/',
        outputFileName: (tag) => {
          return `${tag}.mdx`
        }
      })
    },
  ]
}

所有的组件文档会被自动生成到目标目录下

Template

本项目中有一个默认的模板,也可以使用自己创建的模版,模版使用模版引擎handlebars编写,具体可以参考handlebars,传入的编译数据类型可参考stencil-docs

Interface

| 选项 | 类型 | 描述 | 默认值 | |------|------|------|--------| | template | string | 模板字符串 | 可选 | | templatePath | string | 模板文件路径 | 可选 | | outputDir | string | 输出目录 | 可选 | | outputFileSuffix | string | 输出文件后缀 | 'md' | | outputFileName | (tag: string, file: string) => string | 输出文件名生成函数 | 可选 | | compileOptions | object | 编译选项 | 可选 |