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

agmd

v0.3.15

Published

Automatically generate a directory structure for any file or folder, create Markdown documentation for nodes, classify engineering documents, and convert absolute paths to relative paths.

Downloads

36

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

majun2232majun2232

Keywords

directoryautogeneraterelative pathmdclassificationmarkdown

Readme

Auto-Generate-MD (agmd)

Auto-Generate-MD is a versatile tool designed to enhance front-end code management. Perfect for developers and teams looking to streamline their documentation process, it offers a range of features from automatic markdown generation to detailed project analysis.

简体中文 | English

🚀 Features

  • Automatic Markdown Generation: Enter agmd in any directory to create a markdown file summarizing its contents.
  • Code and File Analysis: Provides statistics on code volume and file types within your project.
  • Path Conversion: Converts absolute paths to relative for easier file navigation in VS Code.
  • Route Marking: Classifies the project based on routes, aiding in project segmentation.
  • Interface-Friendly: Offers a GUI for command operations, eliminating the need to memorize commands.
  • Comprehensive Structure Tree: Generates a JSON tree representing the entire project structure.
  • TypeScript Support: Written in TypeScript with 85% of the code covered by test cases.

Interface Preview

image

Use Cases

image

Installation and Usage

  1. Global Installation:

    • Install globally using npm i agmd -g.
    • Run agmd in the desired directory to generate markdown files.

  2. Dependency Installation:

    • Install as a dev dependency with npm i agmd -D.
    • Configure in package.json for automatic documentation updates.

Command Descriptions

  • Help
  • Generate structure tree document
  • Convert to relative paths
  • Complete file suffix
  • Rename files and folders to KebabCase
  • Mark and categorize files

Advanced Use

  • Classify files using classify.js in the src directory.
  • Access getFileNodes() and getMd() for custom documentation.

Command Line Arguments

  • agmd -h for help.
  • --ignore to exclude files or folders.
  • --include to specify file types for inclusion.

Development and Contribution

This project includes 26 tests for easy expansion and modification. Contributions and PRs are welcome.

Changelog

  • 0.3.15: Code refactoring and updates.
  • 0.3.8: Interface improvements and feature additions.
  • 0.3.0: Major feature updates and UI improvements.
  • 0.2.9: File statistic feature added.
  • 0.2.6: Global installation bug fix.
  • 0.2.0: Support for command-line argument parsing.
  • 0.1.3: Initial release with basic features.

Related Articles

掘金-自动生成目录 md 文件