open-index/open-npm huggingface dataset:
npm package: @kzttools/auto-slugify
Description: this is a pkg which make the slugify easier
Author: kazoottt
Latest version: 0.0.11

# @kzttools/auto-slugify

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![JSDocs][jsdocs-src]][jsdocs-href]
[![License][license-src]][license-href]

## demo

![automatically-generate-slugs](https://pictures.kazoottt.top/2024/02/20240219-b3a3e01f62cec2058120ea89e56da726.png)

demo's site:

<https://slugify.kazoottt.top/>

demo's source code:

<https://github.com/KazooTTT/auto-slugify-webapp>

## 方法: getSlugResult

**描述：** 这个函数用于生成字符串的 slug。

**输入参数：**

| 参数名 | 类型 | 描述 |
| --- | --- | --- |
| str | 字符串 | 要生成 slug 的字符串。 |

**返回值：**

| 类型 | 描述 |
| --- | --- |
| 字符串 | 生成的 slug。 |

**示例用法：**

esm

```javascript
import getSlugResult from "@kzttools/auto-slugify";
...

const slug = await getSlugResult("Hello, World!");
console.log(slug); // 输出: hello-world
```

```javascript
import getSlugResult from "@kzttools/auto-slugify";
...

const slug = await getSlugResult("自动生成slug");
console.log(slug); // 输出: automatically-generate-slugs
```

mjs

``` javascript
const getSlugResult = require("@kzttools/auto-slugify")
...

const slug = await getSlugResult("自动生成slug");
console.log(slug); // 输出: automatically-generate-slugs
```

**注意：** 如果输入的字符串包含中文，函数会先将其翻译为英文，然后再生成 slug。

## Thanks

[bing-translate-api](https://github.com/plainheart/bing-translate-api)

[slugify](https://github.com/simov/slugify)

## License

[MIT](./LICENSE) License © 2024-PRESENT [kazoottt](https://github.com/kazoottt)

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/@kzttools/auto-slugify?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/@kzttools/auto-slugify
[npm-downloads-src]: https://img.shields.io/npm/dm/@kzttools/auto-slugify?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/@kzttools/auto-slugify
[bundle-src]: https://img.shields.io/bundlephobia/minzip/@kzttools/auto-slugify?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=@kzttools/auto-slugify
[license-src]: https://img.shields.io/github/license/kzttools/auto-slugify.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/kzttools/auto-slugify/blob/main/LICENSE
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
[jsdocs-href]: https://www.jsdocs.io/package/@kzttools/auto-slugify
npm package: @kzttools/file-downloader
Description: make file download easier
Author: kazoottt
Latest version: 0.0.12

# file download

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![License][license-src]][license-href]

封装了对于url和blob类型文件的下载方法。

## downloadFileFromURL

``` ts
function downloadFileFromURL(url: string, filename?: string)
```

url是网络请求的链接，filename不是必填，如果填了那么下载文件名称=filename

## downloadFileFromBlob

``` ts
function downloadFileFromBlob(blob: Blob | MediaSource, filename: string)
```

blob是一个blob对象，一般从后端获取，filename不是必填，如果填了那么下载文件名称=filename

# 地址

npm地址：

[@kzttools/file-downloader - npm](https://www.npmjs.com/package/@kzttools/file-downloader)

github地址：

[GitHub - kzttools/file-downloader](https://github.com/kzttools/file-downloader)

## License

[MIT](./LICENSE) License © 2023-PRESENT [kazoottt](https://github.com/kazoottt)

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/@kzttools/file-downloader?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/@kzttools/file-downloader
[npm-downloads-src]: https://img.shields.io/npm/dm/@kzttools/file-downloader?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/@kzttools/file-downloader
[bundle-src]: https://img.shields.io/bundlephobia/minzip/@kzttools/file-downloader?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=@kzttools/file-downloader
[license-src]: https://img.shields.io/github/license/kzttools/file-downloader.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/kzttools/file-downloader/blob/main/LICENSE
npm package: @kzttools/md-to-mdx
Description: Convert Markdown files with front-matter to MDX files with exported metadata.
Author: KazooTTT
Latest version: 0.0.2

# md-to-mdx

[English](./README.md) | [中文](./README.zh-CN.md)

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![License][license-src]][license-href]

将包含 Front Matter 的 Markdown 文件转换为带有 `export const metadata` 的 MDX 文件，方便在 React/Next.js 等框架中直接使用。

## 特性

- 保留 Front Matter 并导出为 `metadata` 对象。
- 支持批量转换目录中的 `.md` 文件，可按需递归子目录。
- 保持正文内容不变，最大限度兼容现有 Markdown/MDX 生态。

## 快速开始

无需安装,直接运行:

```bash
npx @kzttools/md-to-mdx ./content --deep
```

命令行参数：

- `directory`（位置参数，默认 `./`）：需要转换的目录。
- `--deep` / `--no-deep`：是否递归处理子目录。
- `--adapter 原字段:新字段`：转换 Front Matter 字段名，可重复使用。
- `--out ./output`：将生成的文件输出到指定目录（单文件模式可传 `.mdx` 文件路径）。
- `-h` / `--help`：显示帮助信息。

工具会在原目录旁生成 `.mdx` 文件，并自动注入 `export const metadata = { ... }`。

只想处理某个单独的 Markdown?直接指向该文件即可:

```bash
npx @kzttools/md-to-mdx ./posts/about.md
```

希望输出到独立目录?使用 `--out` 指定:

```bash
npx @kzttools/md-to-mdx ./content --deep --out ./converted
```

### 安装到项目或全局

```bash
# 项目内开发依赖
pnpm add -D @kzttools/md-to-mdx

# 全局安装
pnpm add -g @kzttools/md-to-mdx
```

安装后可直接通过 `pnpm md-to-mdx ./notes` 或全局的 `md-to-mdx ./notes` 运行。

## 许可证

[MIT](./LICENSE.md) License © [KazooTTT](https://github.com/kazoottt)

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/@kzttools/md-to-mdx?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/@kzttools/md-to-mdx
[npm-downloads-src]: https://img.shields.io/npm/dm/@kzttools/md-to-mdx?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/@kzttools/md-to-mdx
[bundle-src]: https://img.shields.io/bundlephobia/minzip/@kzttools/md-to-mdx?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=@kzttools/md-to-mdx
[license-src]: https://img.shields.io/github/license/kazoottt/md-to-mdx.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/kazoottt/md-to-mdx/blob/main/LICENSE.md