feat: 新官网基础配置

antvis · Nov 4, 2019 · 938b563 · 938b563
1 parent 679aadd
commit 938b563
Show file tree

Hide file tree

Showing 26 changed files with 1,938 additions and 26 deletions.
diff --git a/.babelrc b/.babelrc
@@ -9,6 +9,7 @@
         "loose": true,
         "modules": false
       }
-    ]
+    ],
+    "babel-preset-gatsby"
   ]
 }
diff --git a/.gitignore b/.gitignore
@@ -73,3 +73,5 @@ demos/debug.html
 
 *.sw*
 *.un~
+public
+.cache
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/api.zh.md b/docs/api.zh.md
@@ -0,0 +1,23 @@
+---
+title: API
+order: 1
+---
+当引入 F2 之后，就可以使用全局命名空间 `F2`。
+
+## 常量 Constants
+
+```javascript
+F2.version // 当前 F2 的版本号
+```
+
+## 类 Classes
+
+- [F2.Chart](api/chart)：图表的入口类
+
+- [F2.G](api/g)：底层绘图引擎（基于原生的 Html5 Canvas 接口封装）
+
+- [F2.Shape](api/shape)：F2 Shape 图形扩展接口，用于自定义各种几何标记的 shape
+
+- [F2.Global](api/global)：F2 的全局配置，包含图表的皮肤样式
+
+- [F2.Util](api/util)：辅助类工具函数
-Original file line number
+Diff line change
@@ Expand Up / @@ -73,3 +73,5 @@ demos/debug.html @@
     *.sw*
     *.un~
+    public
+    .cache