10000 Chinese Translation. They are not finished yet. by benluo · Pull Request #8 · enyojs/enyo-docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Chinese Translation. They are not finished yet. #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 30 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@

#Enyo.js API Reference Generator
#Enyo.js API 参考生成器

The purpose of this project is to coordinate the accumulation and generation of the API documentation reference for [enyo](https://github.com/enyojs/enyo) and its [public libraries](https://github.com/enyojs). It accomplishes this by leveraging available technologies, including itself, according to the limitations of its requirements at the time it was originally authored.
本项目的目的是为 [enyo](https://github.com/enyojs/enyo) 和它的[公共库](https://github.com/enyojs)积累和生成 API 参考文档。这个目的可以通过已有的技术力量,包括enyo自己, 根据那个时候要求自己编写的局限性。

> In the future, [my hope](https://github.com/clinuz) is that the project will be able to better fulfill its ultimate purpose by coordinating all documentation and developer 10000 guidance into a single, normalized and cohesive source that is performant, extensible and comprehensive. For now, that is not possible.
> 这个项目的最终目的是协调所有文档和开发指南,让它们整合在一个统一的,标准化的和内聚的源内,这个源可展示,可扩展,可理解。今后,[我希望](https://github.com/clinuz) 这个项目能更好地满足这个目的。目前为止,这个愿望不可能实现。

### System requirements
### 系统要求

The developer guide requires a unix-y shell. If you wish to build the full docs you will need Linux or Mac OS X. If you're feeling adventurous, you can convert the shell task into a grunt task (possibly with grunt-pandoc or one of the pandoc node modules.
开发者指南要求 Unix 类的 shell。如果你希望创建完整的文档,你需要 Linux 或者 Mac OS X。如果你想冒险,你可以把 shell 任务转换成 grunt 任务(可能用 grunt-pandoc 或者 pandoc node 模块)。

### Technologies
### 技术

##### Required Core Technologies
##### 要求的核心技术

- [Node.js](http://nodejs.org/) - Everything relies on `node`
- [npm](https://www.npmjs.org/) - Package manager for [Node.js](http://nodejs.org) (installed with node)
- [pandoc](http://johnmacfarlane.net/pandoc/) - A universal document converter, used to convert markdown to HTML. Be sure to make available on your path if it is not. (tip: 'brew install pandoc' on Mac)
- [Node.js](http://nodejs.org/) - 有关 `node` 的所有东西
- [npm](https://www.npmjs.org/) - [Node.js](http://nodejs.org) 的包管理(已经与node一起安装)
- [pandoc](http://johnmacfarlane.net/pandoc/) - 通用文档转换工具,用来将 markdown 文件转换成 HTML 文件。确保它在你的可执行路径中。(小窍门:在 Mac里用 'brew install pandoc')

##### Global npm Requirements
##### 要求全局 npm

- [Grunt.js](http://gruntjs.com/) - Command line client: `npm install -g grunt-cli`
- [Bower](http://bower.io/) - Dependency management tool: `npm install -g bower`
- [Grunt.js](http://gruntjs.com/) - 命令行客户端: `npm install -g grunt-cli`
- [Bower](http://bower.io/) - 依赖管理工具: `npm install -g bower`

##### Incorporated Technologies
##### 集成技术

Execute `npm install` and then `bower install` in the *enyo-docs* directory to install these additional requirements:
在 *enyo-docs* 目录下运行 `npm install` 然后 `bower install` 来安然更多需要的东西。

- [JSdoc3](http://usejsdoc.org) - The backbone of our documentation syntax and parser/generator
- [Nunjucks](http://mozilla.github.io/nunjucks/) - The templating engine used to generate static HTML content
- [Grunt.js](http://gruntjs.com/) - Task runner to help automate certain portions of generating and building the site
- [Prism.js](http://prismjs.com/) - The code/syntax highlighter in the output
- [JQuery](http://jquery.com/) - The runtime progressive-enhancement JavaScript library used to interact with the static DOM
- [JSdoc3](http://usejsdoc.org) - 本文档最主要的语法和解析/生成工具
- [Nunjucks](http://mozilla.github.io/nunjucks/) - 模板引擎,用于生成静态 HTML 内容
- [Grunt.js](http://gruntjs.com/) - 任务运行器,用来帮助自动生成和创建网站那部分
- [Prism.js](http://prismjs.com/) - 在输出时用的代码/语法高亮工具
- [JQuery](http://jquery.com/) - 作为运行时的先进增强JavaScript库,用于静态 DOM 的交互

### File System Setup
### 文件系统设定

The enyo-docs scripts assume that enyo and its libraries will be siblings and the libraries will be in the *lib* directory in the standard Bootplate way. In other words:
enyo-docs 脚本假定 enyo 和它的库是兄弟关系,库是在 *lib* 目录中,像 Bootplate 标准的方式。换句话说:

```
Parent
Expand All @@ -48,21 +48,21 @@ Parent
+- spotlight
```

Directories to be scanned (and other options for jsDoc) can be found in *jsdoc-conf.json*
被扫描的目录(和其它 jsDoc 选项)可以在 *jsdoc-conf.json* 里发现。

### Building The Docs
### 创建文档

To build the docs, simply execute grunt in the *enyo-docs* directory:
为了创建文档,简单地在 *enyo-docs* 目录中运行 grunt:

```
grunt
```

Generated docs go into the *output* directory.
生成的文档会在 *output* 目录内。

### Additional notes
### 更多注解

Two special 'macros' are used within the enyo docs source:
两个特别的 'macros' 会用在 enyo 文档源中:

* `$api` - Converted into the relative location of the root document directory. Used primarily in the developer-guide to locate api references.
* `$dev-guide` - Converted into the relative location of the developer guide. Used primarily in the enyo source to point towards the developer guide articles.
* `$api` - 转换成文档根目录相对位置。主要用在 developer-guide 里定位 api 参照。
* `$dev-guide` - 转换成开发者指南的相对位置。主要用于在 enyo 源内指向开发者指南的文章。
14 changes: 7 additions & 7 deletions developer-guide/design.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
% Design Guide
% 设计指南

We are pleased to offer the following resources to those designing apps using
the Enyo framework and Moonstone UI library:
我们很高兴地提供下面的资源给开发者,他们使用 Enyo UI 和 Moonstone UI 框架库来
设计应用:

* [Design Principles](design/principles.html)
* [设计原则](design/principles.html)

* [UI Patterns](design/patterns.html)
* [UI 模式](design/patterns.html)

* [UI Controls](design/controls.html)
* [UI 控制](design/controls.html)

* [Styles](design/styles.html)
* [风格](design/styles.html)
Loading
0