小丫开发工具站
返回工具合集
README文档在线生成器
可视化配置项目信息，一键生成标准readme.md，支持Github/Gitee仓库文档、项目徽章、技术栈、开源协议，实时预览Markdown渲染效果
项目基础信息
一款轻量化本地文件处理工具，无依赖、开箱即用，支持批量文本转换与内容清洗。
项目徽章
MIT开源协议
Apache 2.0协议
版本标签
构建通过
构建失败
测试覆盖率
NPM包标识
下载统计
Github Star
Github Issues
欢迎PR提交
添加徽章
技术栈标签
JavaScript
TypeScript
Python
Golang
Rust
Node.js
React
Vue3
Docker
MySQL
MongoDB
Redis
功能特性
×
×
×
+ 新增一条特性
安装方式
npm
yarn
pnpm
pip
go get
cargo
调用示例
import fileUtil from 'light-file-util'; const result = fileUtil.cleanText("待处理文本内容"); console.log(result);
API文档
### cleanText(opt) 文本清洗处理接口 参数： - opt.raw: string，原始文本 - opt.filterSymbol: boolean，是否过滤符号 返回：处理完成字符串
贡献指引
开源许可证
MIT
Apache 2.0
GPL 3.0
BSD 3-Clause
ISC
Unlicense
生成README文档
Markdown源码
渲染预览
📋 复制源码
💾 下载README.md
📖 使用说明
README文档在线生成工具专为开源仓库、Github、Gitee项目打造，可视化填写内容自动组装标准markdown文档
可自由开启关闭项目徽章、技术栈标签、功能特性、安装命令、代码示例、API说明、贡献指南、开源协议模块
支持版本、构建状态、覆盖率、开源协议、star数量等常用shields徽章，自动识别github仓库链接填充徽章地址
实时预览渲染效果，所见即所得，生成后一键复制源码或者直接下载README.md文件到本地
全部计算渲染在浏览器本地执行，项目信息不会上传服务器，保护项目内容安全
适合前端项目、后端服务、脚本工具、组件库、Python工具包、Rust程序等各类开源项目快速制作仓库主页文档
操作完成