Flame-CN / flame-guide

Flame中文官方指南 仓库

Flame中文 官方指南

教程文档仓库

文章规范

1. 所有的文章统一使用Markdown语法进行编写。

2. 目录结构规范：

   • doc为顶级目录。
   • doc下方按层级进行分类（最好不要超过3级，否则排版将会不美观）。
   • 在分类下按层级+文章名称创建目录。
   • 在文章目录下创建同名的文章MD文件。
   • 在文章目录下按文章名顺序命名资源文件。

   比如：

   └── doc
       ├── 1.关于Flame
       │   ├── 1.1.Flame团队
       │   │   ├── Flame团队-01.png
       │   │   ├── Flame团队-02.png
       │   │   └── Flame团队.md
       │   └── 1.2.Flame介绍
       │       └── Flame介绍.md
       └── 2.快速开始
           └── 2.1.安装Flame
               └── 安装Flame.md
   

   优良、规范、清晰地目录结构将会大大降低移植难度。

3. 文章命名规范

   • 命名字数在保证明义的前提下，尽可能缩短字数。

4. 文章内容规范 TOD