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

@higher/code-note

v1.1.1

Published

直接根据项目代码注释生成文档

Downloads

8

Readme

根据注释生成笔记文件

起源

平时做项目可能会遇到大大小小的问题,如果不记录以后可能就忘记了,但是怎么记录呢?再去开个md编辑器不方便,可以直接写在代码里,然后通过此工具一键生成md,别人看你的代码还有可能得到启发

使用

请务必用多行注释

代码注释书写格式@note

/**
 * 给笔记起个标题吧
 * @note 在这里写笔记吧
 * @note 换行接着写,也可以
 * 这样写也ok
 */
<!-- 
  html注释也是支持的
  @note 在这里写注释
  @note 换一行
 -->
'''
python也是支持的
@note 这里写注释
'''

命令行

# 安装
npm install @higher/code-note -g
# 切换到目录
cd dir
# 执行命令 cn 目录 生成文件名
cn . output # => ./output.md