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

tdoc-cli

v1.0.0

Published

前端工程文档开发工具

Downloads

9

Readme

简介

前端工程文档生成工具,方便开发者通过md文档能快速构建出系统完整的文档页面。

npm version

安装

npm install tdoc-cli [-g]

使用方式

  • cd /path/to/project/ 进入项目目录
  • tdoc init 初始化tdoc配置文件,编写配置文件tdoc.config (配置及配置文件请查看 配置说明)
  • tdoc build 构建文档
  • tdoc server 启动服务,访问文档页面效果

详细请查看命令使用方式说明

产出页面效果截图

使用其他方式

  1. 使用脚本:

    var tdoc = require("tdoc");
    
    tdoc.build('/path/to/project', options);
  2. 使用Gulp:

    var tdoc = require("tdoc");
    
    gulp.task('tdoc', function() {
        return gulp.src('./')
            .pipe(tdoc({
                // 配置
            }));
    });

ToDo

  • [x] 可以init出一个完整简单示例,方便用户能迅速入门
  • [x] 要能结合gulp和browsersync
  • [x] 能够起本地server服务预览
  • [ ] 在子目录页面中实现异步请求数据,解决了刷新页面的烦恼
  • [ ] 精简产出的页面中的source文件夹下的js和css文件
  • [ ] 新增命令,能通过命令直接识别summry.md来自动生成json配置文件,将md转换成html