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

mkmdls

v2024.7.30-95849

Published

A CLI utility to generate markdown files from glob patterns.

Downloads

22

Readme

mkmdls (Make Markdown Listing)

Description

mkmdls is a command-line utility that generates markdown files from specified file globs. It helps you create organized markdown documentation by listing the content of your files and providing a directory tree view.

Features

  • Generate markdown files from specified file patterns.
  • Include file content and directory tree in the markdown.
  • Option to include or exclude files using glob patterns.
  • Configurable output file location and naming.
  • Verbose and silent logging options.

Installation

To install the package, you can use npm:

npm install -g mkmdls

Usage

NPX

If you prefer not to install the package globally, you can use npx to run it:

npx mkmdls [options]

Basic Usage

To generate a markdown file listing the content of files matching the provided globs:

mkmdls -i "src/**/*.ts" -o "listing.md" -d "./"

Options

  • -i, --input <globs...>: A list of globs of files to find.
  • -o, --output <file>: The output markdown file. Default: output.md.
  • -d, --directory <dir>: The target directory for input and output. Default: ..
  • -f, --force: Ignore if the output file already exists.
  • -t, --title <title>: The title of the markdown file. Default: File Listing.
  • -c, --config <boolean>: Include the config in the generated markdown. Default: true.
  • -l, --listing <boolean>: Include the file tree listing in the generated markdown. Default: true.
  • -x, --exclude <globs...>: A list of globs to ignore. Default: ["node_modules/**", "dist/**", "build/**"].
  • -s, --silent: Run in silent mode with minimal output.
  • -v, --verbose: Run in verbose mode with detailed output.

Examples

Generating a Markdown Listing with File Tree

mkmdls -i "src/**/*.ts" -o "output.md" -t "Source Files"

Excluding Certain Files

mkmdls -i "src/**/*.ts" -o "output.md" -x "src/test/**"

Overwriting an Existing Output File

mkmdls -i "src/**/*.ts" -o "output.md" -f

Running in Silent Mode

mkmdls -i "src/**/*.ts" -o "output.md" -s

Running in Verbose Mode

mkmdls -i "src/**/*.ts" -o "output.md" -v

NPM Package

The package is available on npm.

Repository

For more information, visit the GitHub repository.