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

leizu

v0.0.2

Published

[![GitHub stars](https://img.shields.io/github/stars/zouhangwithsweet/vue-components-lib-seed)](https://github.com/zouhangwithsweet/vue-components-lib-seed/stargazers)

Downloads

5

Readme

A Vue3 UI library template

GitHub stars

中文文档

Help you quickly create a component library.

  • :rocket: dev with Vite
  • :airplane: build with esbuild
  • :helicopter: generate types with ts-morph

Docs

power by vitepress

Feature

  • :rainbow: Speedy dev & build
  • :fireworks: Customize friendly
  • :pencil: More beautiful doc, support Chinese and English. Support Dark Mode by vueuse
  • :lollipop: Rich scripts, inspired by esbuild-plugin-vue & vue-dts-gen
  • :yum: Type friendly
  • :truck: ESM & CJS product

How to use

Generate a repository by vue-components-lib-seed

Checklist

  • [ ] Replace all leizu words with your libary name. Just search leizu and replace them in VScode
    • .gitignore
    • package.json
    • vite.config.ts
    • .vitepress
    • scripts ...

Install

yarn

Dev

Benefited from vite-plugin-pages, the src/pages/index.vue is the entry page for development. You can visit /[component-name]/demo to check component, like http://localhost:3000/#/button/demo.

yarn dev

Build

yarn build

Test

yarn test

Generate entry point

The entry file is the input option for rollup.

yarn gen-entry

Generate Component

A component's name is required for this command.

yarn gen [component\'s name]

Generate dts

npx esno ./scripts/gen-dts.ts

Release

This command will add git tag、generate changelog. You can test your lib with argument --dry

yarn release [--dry]

Build Docs

:exclamation: Noted: you should run yarn build:lib before run this command. Because the docs need the build bundle.

Docs dev

yarn docs:dev

Docs build

yarn docs:build

Docs deploy

Here is a git action. When you push the code to the master branch, the document will be automatically deployed on gh-pages branch. Then you can set the Github Pages's source on the gh-pages branch.

Use demo code in doc

Take button as an example.

In button.md, insert the following code

:::demo  
src/packages/button/demo/demo0.vue  
:::
- or
:::demo  
src/packages/button/demo/demo*.vue  
:::

~~There is a global component Demos to display all demos. This is currently the only way to show demo. More info.~~

Custom doc style

You can add the class in frontmatter, then the <Content> would inherit the class. Of course, the unocss can be used here.

---
class: 'custom-class'
---

Recommended IDE Setup

VSCode + Volar.

If Using <script setup>

<script setup> is a feature that is currently in RFC stage. To get proper IDE support for the syntax, use Volar instead of Vetur (and disable Vetur).

Credits

Thanks

| eeeeelle :writing_hand:release-script | | :---: |