文件夹说明

content文件夹

存放文档主要内容。Products-Help-PublicContents仓库中的所有内容，产品文档仓库中的所有内容，例如iDesktop Java的文档仓库iDesktop-Java-MainDocs都需要拷贝到此文件夹下。

src文件夹

存放页面相关的风格样式文件。

locale文件夹

src/locale 文件夹中存放的是产品的本地化资源，本地化资源各个产品不完全相同。为便于产品维护，在产品文档仓库中也放置了src/locale文件夹，存放产品的本地化资源。使用时，直接剪贴locale文件夹中的内容。

如何使用

将所有文件夹，直接拷贝到content文件夹下。content文件夹，需要从Products-Help-MainFrame仓库下载。

一个完整的产品帮助文档，由以下三个仓库的内容组成：

• Products-Help-MainFrame
• Products-Help-PublicContents
• 产品文档仓库内容：命名规则：产品名称-MainDocs

其中，Products-Help-PublicContents仓库中的所有内容，产品文档仓库中的所有内容，都需要拷贝到Products-Help-MainFrame仓库中的content文件夹下。

如何编译文档

需要的环境

Node.js

Node.js的安装与配置，请参照Node.js的官网https://nodejs.org/en/

Yarn

Yarn的安装，可参照https://www.yarnpkg.com/zh-Hans/

命令行安装Gatsby开发环境

npm install -g gatsby-cli 全局安装（不用进入项目目录）

本地编译

如果是首次从Github仓库中下载源码文件，则需要为其安装依赖。打开cmd，路径跳转到源码目录下：

1. 执行 yarn 或yarn install 安装全部依赖。

2. 执行yarn dev -p 端口号。

yarn dev 命令是开发环境下编译本地文件。 注意：dev 开发环境时，需要注释掉src/components/Layout/layout.js中build生产环境的代码： locationPath = locationPath.substring(locationPath.replace('/', 'a').indexOf('/'), locationPath.length); 使用 gatsby build 命令时，需要取消注释。

3. 本地浏览器中，输入 localhost:端口号，访问在线文档。

配置产品名称

需要配置产品名称，修改 gatsby-config.js 中的代码：

pathPrefix: /****,

如何发布文档

1. 本地调试：gatsby build --prefix-paths
2. 本地发布：gatsby serve --prefix-paths
3. 在本地调试发布的内容无误后，可以使用Tomcat对文档内容进行发布。 使用Tomcat发布，需将编译生成的public文件，拷贝到webapps文件夹下，并将public文件夹名称修改为对应的产品名称。

License

Content submitted to reactjs.org is CC-BY-4.0 licensed, as found in the LICENSE-DOCS.md file.