# mendown

> Next Generation Markdown Tooling.

Latest version **0.0.0** (published 2023-11-25) · AGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install mendown
pnpm add mendown
yarn add mendown
bun add mendown
```

Provides the command `mendown`.

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.0 |
| Published | 2023-11-25 |
| First published | 2023-11-25 |
| Weekly downloads | 0 |
| License | AGPL-3.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 10 |
| Unpacked size | 63.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | JacobLinCool |
| Maintainers | jacoblincool |

## Links

- npm: https://www.npmjs.com/package/mendown
- Repository: https://github.com/JacobLinCool/mendown
- Homepage: https://jacoblincool.github.io/mendown
- Issues: https://github.com/JacobLinCool/mendown/issues
- npm.io page: https://npm.io/package/mendown

## Dependencies (10)

- [zod](https://npm.io/package/zod.md) ^3.22.4
- [debug](https://npm.io/package/debug.md) ^4.3.4
- [dotenv](https://npm.io/package/dotenv.md) ^16.3.1
- [openai](https://npm.io/package/openai.md) ^4.20.0
- [remark](https://npm.io/package/remark.md) ^15.0.1
- [unified](https://npm.io/package/unified.md) ^11.0.4
- [@ai-d/aid](https://npm.io/package/@ai-d/aid.md) ^0.1.0
- [commander](https://npm.io/package/commander.md) ^11.1.0
- [remark-parse](https://npm.io/package/remark-parse.md) ^11.0.0
- [unist-util-visit](https://npm.io/package/unist-util-visit.md) ^5.0.0

## Recent versions

- 0.0.0 (latest) — 2023-11-25

## README

# Mendown: Next Generation Markdown Tooling

## Introduction

`Mendown` is a powerful, next-generation tool designed to enhance your Markdown documents. `Mendown` integrates advanced features like automatic image description and link validation, making it an indispensable tool for Markdown users.

## Features

- **Image Description**: Automatically generates descriptions for images in your Markdown files, utilizing OpenAI's GPT-4 Vision model.
- **Link Validation**: Checks and reports broken links in your document, ensuring the integrity of your Markdown file.

## Installation

To install `Mendown`, use the following command:

```bash
pnpm i -g mendown
```

This command installs `Mendown` globally on your system, allowing you to use it in any directory.

## Usage

To use `Mendown`, simply run it from the command line with your desired Markdown file:

```bash
mendown <file>
```

> To use `image-describer`, you must set the `OPENAI_API_KEY` environment variable to your OpenAI API key.

### Command Line Options

- `<file>`: Path to the Markdown file to convert.
- `-o, --output <file>`: Specify an output file. If not provided, `Mendown` will output to stdout.
- `-w, --write`: Enables in-place editing of the input file.
- `-t, --tool <...tools>`: Specify tools to enable. By default, all tools are enabled. Available tools are `link-probe` and `image-describer`.

### Examples

1. **Basic Usage**: Convert a Markdown file and output to stdout.
   ```bash
   mendown myfile.md
   ```

2. **Specifying an Output File**: Convert and output to a specific file.
   ```bash
   mendown myfile.md -o output.md
   ```

3. **In-Place Editing**: Edit the Markdown file directly.
   ```bash
   mendown myfile.md -w
   ```

4. **Using Specific Tools**: Only use the link-probe tool.
   ```bash
   mendown myfile.md -t link-probe
   ```

## Contributing

Contributions to `Mendown` are welcome! Visit the [GitHub repository](https://github.com/JacobLinCool/mendown) to contribute.

## License

`Mendown` is licensed under AGPL-3.0.

## Contact

For any queries or issues, please open an issue on the [GitHub issues page](https://github.com/JacobLinCool/mendown/issues).

---
_Source: https://npm.io/package/mendown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._