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

my-vue-doc

v0.0.4

Published

这是一个用于创建my系列控件文档的框架,样式参考iview。目前不对外开放,仅针对my系列控件定制化使用。

Downloads

5

Readme

使用

使用npm安装my-vue-doc到全局。

npm install my-vue-doc -g

my-vue-doc提供了cli工具给my系列库做文档服务。

初始化

执行:

mydoc init

然后会在当前工程中创建一个/docs-src目录。

编辑模式

执行:

mydoc dev

然后在/docs-src/pages目录中编辑文档即可。

发布模式

执行:

mydoc build

会build出docs目录。

目录说明

该框架留给用户配置有三处:

  • 文档目录
  • 例子目录
  • 全局配置

文档目录

文档目录在/docs-src/pages中,不同于VuePress那种基于MD,该框架是使用Vue的标签构建文档的,这些文档就创建在该目录中。

创建文档的Vue控件,请参考基础控件 和高级控件。

文档的首页要求是在pages目录下的index.vue页面,该页面框架会做静态化,以提升seo的效率,其他页面不会做静态化处理。

例子目录

供Demo控件使用的例子vue文件所放目录。该目录的文件会通过框架开发的vue-source_loader将Demo的源码读取出来,供Demo框架展示。

全局配置

/docs-src/app.js是框架的主配置文件,配置如文档库名称、版本等功能,具体请参考

app.js

可以在/docs-src/app.js中引入全局样式或者当前库。