Nodejs docor 自动从package.json生成排版好看的readme

Nodejs docor 自动从package.json生成排版好看的readme

很多人懒得写readme，虽然markdown写起来已经够简单了，但是还是写不出好看的readme，因为觉得写文档是一件很麻烦的事情，我经常在npm上开坑，发现readme很多东西都可以从package.json中抓出来然后排版好，docor这个工具就做了这样一个工作。

$ sudo npm install docor -g

然后在你的目录下npm init之后，会有一个package.json文件，这个时候在本目录执行 docor 就可以看到生成的readme，根据pkg指定的license文件，和相应的ignore文件了。

我还写了一些小功能，比如从pkg.main文件里将暴露出来的函数打印在readme中，方便以后写api文档。如果要指定文档的logo，可以在package.json中加一个 { “logo”: “someurl” }

目前有两个readme模板，如果希望要自己修改这个默认模板，可以在你的全局模块目录里修改 tpl/readme.md

如果要新建中文语言的readme，可以这样: $ docor -c README.zh-cn.md，中文模板文件也在tpl目录下。

Github: https://github.com/turingou/docor


3 回复

Nodejs docor 自动从package.json生成排版好看的readme

很多人懒得写readme，虽然markdown写起来已经够简单了，但是还是写不出好看的readme，因为觉得写文档是一件很麻烦的事情。我经常在npm上开坑，发现readme很多东西都可以从package.json中抓出来然后排版好，docor这个工具就做了这样一个工作。

安装

首先，你需要安装docor工具。你可以使用以下命令全局安装：

$ sudo npm install docor -g

使用

安装完成后，在你的项目根目录下运行npm init，这将会生成一个package.json文件。此时，你可以在项目根目录下运行docor命令来生成一个美观的readme文件。

$ docor

功能详解

docor能够自动从package.json文件中提取信息，并生成排版好看的readme文件。具体来说，它可以从package.json中的main字段读取暴露出来的函数，并将其打印到readme中，方便以后编写API文档。

例如，假设你的package.json文件中有如下配置：

{
  "name": "my-package",
  "version": "1.0.0",
  "description": "A sample package",
  "main": "index.js",
  "license": "MIT",
  "logo": "https://example.com/logo.png"
}

docor将会根据这些信息生成一个readme文件，其中包含了项目的名称、版本、描述、许可证等信息，甚至包括了自定义的logo。

模板定制

docor提供了两个readme模板，默认模板位于全局模块目录下的tpl/readme.md文件中。如果你希望修改默认模板，可以直接编辑这个文件。此外，你还可以添加新的模板以支持不同的语言或风格。

例如，要生成一个中文的readme文件，可以使用以下命令：

$ docor -c README.zh-cn.md

中文模板文件同样位于tpl目录下。

示例代码

假设你有一个简单的Node.js项目，包含以下package.json文件：

{
  "name": "my-package",
  "version": "1.0.0",
  "description": "A sample package",
  "main": "index.js",
  "license": "MIT",
  "logo": "https://example.com/logo.png"
}

运行docor命令后，将会生成一个类似如下的readme文件：

# My Package

![Logo](https://example.com/logo.png)

## Description
A sample package

## Main Exposed Functions
- `function1`
- `function2`
- `function3`

## License
MIT

通过这种方式，你可以轻松地为你的Node.js项目生成一个美观且信息丰富的readme文件。

结论

docor是一个非常有用的工具，可以帮助开发者快速生成排版好看的readme文件。通过从package.json文件中提取信息并结合预定义的模板，docor简化了文档编写的过程，使开发者能够更专注于实际的开发工作。

更多详细信息和源码可以查看 GitHub。


听起来不错，有时间试试。

docor 是一个用于自动生成 README 文件的 Node.js 工具，它可以从 package.json 文件中提取信息并生成格式化的 README 文档。以下是如何使用 docor 来实现这一目标的具体步骤。

安装 docor

首先，你需要全局安装 docor：

$ sudo npm install docor -g

初始化项目

如果你还没有 package.json 文件，可以通过运行 npm init 命令来初始化一个新的项目：

$ npm init

这将会引导你完成 package.json 文件的创建过程。

使用 docor 生成 README

在项目根目录下，只需运行以下命令：

$ docor

这将基于当前项目的 package.json 生成一个 README 文件，并且会使用 docor 默认的模板。

配置 package.json

你可以在 package.json 中添加一些额外的配置项来定制生成的 README，例如添加 logo 图片或者指定特定的语言模板：

{
  "name": "your-project-name",
  "version": "1.0.0",
  "description": "Your project description",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "Your Name",
  "license": "ISC",
  "logo": "https://example.com/logo.png" // 添加 logo
}

生成多语言 README

如果你想生成不同语言的 README，你可以使用 -c 参数指定输出文件名，比如生成中文 README：

$ docor -c README.zh-cn.md

修改模板

如果你想要自定义 docor 的模板，你可以找到全局安装位置中的模板文件夹，并修改 tpl/readme.md 文件以符合你的需求。

docor 使得生成美观的 README 变得非常简单，无需手动编写大量的 Markdown 代码。

回到顶部