jsdoc-to-markdown

自动将JSDoc注释生成Markdown格式API文档的工具

jsdoc-to-markdown是一个将JSDoc注释转换为Markdown格式API文档的开源工具。它可从注释中提取函数签名、参数列表和返回值描述，生成格式清晰的Markdown文档。这个工具主要用于自动化API文档生成，简化了开发者在项目README中添加API文档的过程。通过简单的命令行操作，jsdoc-to-markdown能够快速生成标准化的API文档，提高了文档维护效率。

jsdoc-to-markdownAPI文档生成JavaScriptMarkdown源代码注释Github开源项目

访问官网

GitHub

文档

jsdoc-to-markdown

升级用户请阅读发布说明

jsdoc-to-markdown

从带有 jsdoc 注释的源代码生成 markdown 格式的 API 文档。适用于将 API 文档注入到项目的 README 文件中。

概要

1. 使用有效的 jsdoc 注释来编写代码文档。

[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

2. 运行命令。

$ jsdoc2md example.js

3. 获得 markdown 输出。

[object Object],[object Object],[object Object],[object Object],[object Object]

安装

$ npm install --save-dev jsdoc-to-markdown

另请参阅

API 文档
wiki 包含示例输出、常见问题、教程、插件、与 gulp/grunt 等工具的集成使用等内容。

由 test-runner 进行测试。

编辑推荐精选

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境（IDE），通过自动化和多元协作改变开发流程。利用Trae，团队能够更快速、精确地编写和部署代码，从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能，是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门

问小白

全能AI智能助手，随时解答生活与工作的多样问题

问小白，由元石科技研发的AI智能助手，快速准确地解答各种生活和工作问题，包括但不限于搜索、规划和社交互动，帮助用户在日常生活中提高效率，轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手，它拥有超精准的音频识别翻译能力，几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球，无论你是留学生、商务人士、韩剧美剧爱好者，还是出国游玩、多国会议、跨国追星等等，都可以满足你所有需要同传的场景需求，线上线下通用，扫除语言障碍，让全世界的语言交流不再有国界。

讯飞智文

一键生成PPT和Word，让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目，能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定，还是学生群体的职业生涯规划、实习避坑指南，亦或是活动策划、旅游攻略等内容，它都能提供支持，帮助用户精准表达，轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门

讯飞星火

深度推理能力全新升级，全面对标OpenAI o1

科大讯飞的星火大模型，支持语言理解、知识问答和文本创作等多功能，适用于多种文件和业务场景，提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台，涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能，能为不同需求的用户提供便捷高效的帮助，助力用户轻松获取信息、解决问题，满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目，由多个知名机构联合参与。该项目提供了高效的 LLM（大语言模型）驱动的语音合成方案，支持语音克隆和语音创建功能，可通过命令行界面（CLI）和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数，生成高质量的语音。该项目适用于多种场景，如有声读物制作、智能语音助手开发等。