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

vitepress-for-component

v0.17.1

Published

dumi like documentation tool

Downloads

76

Readme

vitepress-for-component

npm npm

VFC Fork 自VitePress,针对组件开发场景做了一些功能增强和默认样式修改。

可以理解为是一个在 VitePress 的基础上向 dumi 靠拢的工具。

详细文档.

快速开始

yarn create vlib
  • 不使用脚手架

像 vitepress 一样使用即可。

示例站点

Features

1. 内置Demo组件

我们可以在.md文件中这样来引入demo

<demo src="./demo.vue"
  language="vue"
  title="Demo演示"
  desc="这是一个Demo渲染示例">
</demo>

渲染效果如下:

2. 像 dumi 一样的组织文件

在组件编写的场景中,我们觉得 dumi 的文件结构更合适。

示例:

假设我们有这样一个组件库。

VitePress文件结构如下。

docs
├─ index.md
├─ loading
│  └─ index.md
├─ zh
│  ├─ index.md
│  └─ loading
│     └─ index.md
src
├── loading
│ ├── demo
│ │ └── demo.vue
│ └── loading.vue
└── ...

vitepress-for-componnet文件结构如下。

docs
├── index.en-US.md
├── index.zh-CN.md
src
├── loading
│ ├── demo
│ │ └── demo.vue
│ ├── index.en-US.md
│ ├── index.zh-CN.md
│ └── loading.vue
└── ...

我们觉得dumi的组织结构有如下好处:

  • demo.vue 和 loading.md 都放在 src 下面,源码和文档联系感更强。
  • 用后缀.zh-CN来区分 locale,更加有对比度。

3. 更合适的默认样式

如图: