<commit_before># Dgeni - 文档生成器 [![Build Status](https://travis-ci.org/angular/dgeni.svg?branch=master)](https://travis-ci.org/angular/dgeni)

![](assets/dgeni-logo-600x400.png)

用 angular.js 和其他工程构建的 node.js 文档生成工具。

## 入门

试试看 Dgeni [示例项目](https://github.com/petebacondarwin/dgeni-example)。或者你在找的是[用 AngularJS](https://github.com/petebacondarwin/dgeni-angular)的例子。

观看 Pete 在 ng-europe 上关于 Dgeni 的演讲：

[![ScreenShot](http://img.youtube.com/vi/PQNROxXajyQ/0.jpg)](http://youtu.be/PQNROxXajyQ)

## 安装

为了使用 Dgeni，你需要 node.js 和 npm 来安装 Dgeni 关联模块。从这里获取 node.js：
http://nodejs.org/.

然后在你想生成文档的工程目录下安装 Dgeni：

```
npm install dgeni --save-dev
```

这会安装 Dgeni 和 Dgeni 相关联的所有模块。

## 运行 Dgeni

对于 Dgeni 本身，你并不用做太多配置。但是你必须配置 **Packages**，它包含了 **Services**
和 **Processors** 两部分。其中 **Processors** 将会实际负责将你的源文件转换成文档文件。<commit_msg>docs(zh_CN): #142 add pronounciation guide<commit_after># Dgeni - 文档生成器 [![Build Status](https://travis-ci.org/angular/dgeni.svg?branch=master)](https://travis-ci.org/angular/dgeni)

![](assets/dgeni-logo-600x400.png)

用 angular.js 和其他工程构建的 node.js 文档生成工具。

Dgeni 念起来有点类似女生名字 Jenny([/ˈdʒɛni/](https://en.wikipedia.org/wiki/Help:IPA_for_English)) 的发音，
也就是 'd' 不发音，而 `g` 轻音。

## 入门

试试看 Dgeni [示例项目](https://github.com/petebacondarwin/dgeni-example)。或者你在找的是[用 AngularJS](https://github.com/petebacondarwin/dgeni-angular)的例子。

观看 Pete 在 ng-europe 上关于 Dgeni 的演讲：

[![ScreenShot](http://img.youtube.com/vi/PQNROxXajyQ/0.jpg)](http://youtu.be/PQNROxXajyQ)

## 安装

为了使用 Dgeni，你需要 node.js 和 npm 来安装 Dgeni 关联模块。从这里获取 node.js：
http://nodejs.org/.

然后在你想生成文档的工程目录下安装 Dgeni：

```
npm install dgeni --save-dev
```

这会安装 Dgeni 和 Dgeni 相关联的所有模块。

## 运行 Dgeni

对于 Dgeni 本身，你并不用做太多配置。但是你必须配置 **Packages**，它包含了 **Services**
和 **Processors** 两部分。其中 **Processors** 将会实际负责将你的源文件转换成文档文件。
{'fraction_non_alphanumeric': 0.173109243697479, 'fraction_numerical': 0.009523809523809525, 'mean_word_length': 5.266666666666667, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 9, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6764640', 'n_tokens_mistral': 1019, 'n_tokens_neox': 1065, 'n_words': 128}