Browse Source

补充帮助文档

master
Cmen 3 years ago
parent
commit
5937821090
  1. 14
      depoly.js
  2. 6
      docs/.vitepress/config.js
  3. 11
      docs/changelog.md
  4. 9
      docs/feedback.md
  5. 8
      docs/start.md
  6. 3
      package.json
  7. 2
      src/editor/Menu/Help.tsx
  8. 3128
      yarn.lock

14
depoly.js

@ -0,0 +1,14 @@
const path = require("path");
const { ncp } = require("ncp");
ncp.limit = 16;
const source = path.resolve(__dirname, "docs", ".vitepress", "dist");
const destination = path.resolve(__dirname, "dist", "docs");
ncp(source, destination, function (err) {
if (err) {
return console.error(err);
}
console.log("done!");
});

6
docs/.vitepress/config.js

@ -1,5 +1,5 @@
module.exports = { module.exports = {
title: 'Fine-GeoJSON-Editor', title: 'Fine-GeoJSON-Editor帮助文档',
description: '在线geojson编辑器.', description: '在线geojson编辑器.',
base: "/docs/", base: "/docs/",
themeConfig: { themeConfig: {
@ -22,6 +22,10 @@ module.exports = {
{ {
link: "/changelog", link: "/changelog",
text: "更新日志" text: "更新日志"
},
{
link: "/feedback",
text: "建议反馈"
} }
] ]
} }

11
docs/changelog.md

@ -1 +1,10 @@
# 更新日志 # 更新日志
## 0.2.0(:tada:预览版:tada:)
- [特性] 文件菜单
- [特性] 编辑菜单
- [特性] 帮助菜单
- [特性] 覆盖物创建|编辑
- [特性] 覆盖物选中|复制|删除
- [特性] 覆盖物属性设置
- [特性] 搜索定位

9
docs/feedback.md

@ -0,0 +1,9 @@
# 建议反馈
使用过程中遇到BUG或者有新的需求, 都可以去 [项目代码仓库](https://code.fanruan.com/Finevis/fine-geojson-editor) 下创建工单.
开发者会及时做出响应.
:::tip
帆软的同事如果有问题或者需求, 可以直接企业微信找 `Cmen` 获取帮助.
:::

8
docs/start.md

@ -4,7 +4,7 @@ Fine-GeoJSON-Editor是一款云端GeoJSON编辑器, 其界面设计参考了诸
除了核心的GeoJSON编辑功能外, 还补充了许多辅助编辑使用的功能. 除了核心的GeoJSON编辑功能外, 还补充了许多辅助编辑使用的功能.
编辑器主要分成四个区域, 如下图 编辑器主要分成四个区域, 如下图
![布局](public/layout.png) ![布局](./public/layout.png)
对应功能分别是. 对应功能分别是.
- 菜单区: 和大多桌面应用一样, 主要提供编辑器使用的一些辅助操作, 诸如打开, 保存, 使用帮助等等. - 菜单区: 和大多桌面应用一样, 主要提供编辑器使用的一些辅助操作, 诸如打开, 保存, 使用帮助等等.
@ -37,7 +37,7 @@ Fine-GeoJSON-Editor是一款云端GeoJSON编辑器, 其界面设计参考了诸
## 主编辑区 ## 主编辑区
### 创建覆盖物 ### 创建覆盖物
在编辑区域的左上角, 有一横排的按钮集合, 用于创建不同的覆盖物, 如下图. 在编辑区域的左上角, 有一横排的按钮集合, 用于创建不同的覆盖物, 如下图.
![创建工具](public/edit.png) ![创建工具](./public/edit.png)
目前支持创建4种覆盖物, 矩形, 多边形, 多段线和圆形. 目前支持创建4种覆盖物, 矩形, 多边形, 多段线和圆形.
:::tip :::tip
@ -58,13 +58,13 @@ Fine-GeoJSON-Editor是一款云端GeoJSON编辑器, 其界面设计参考了诸
#### 搜索定位工具 #### 搜索定位工具
我们点击 `搜索` 按钮, 即可弹出搜索框, 我们点击 `搜索` 按钮, 即可弹出搜索框,
此时输入关键字, 会自动列举可选的目标, 点击对应目标, 即可让底图定位跳转到对应位置. 此时输入关键字, 会自动列举可选的目标, 点击对应目标, 即可让底图定位跳转到对应位置.
![搜索结果](public/search.png) ![搜索结果](./public/search.png)
## 覆盖物目录 ## 覆盖物目录
当我们使用创建工具创建多个覆盖物之后, 左侧的覆盖物目录区, 会自动补充对应的覆盖物列表. 当我们使用创建工具创建多个覆盖物之后, 左侧的覆盖物目录区, 会自动补充对应的覆盖物列表.
按照类型存放在不同的分类下. 按照类型存放在不同的分类下.
我们可以单击选中指定的覆盖物, 对应的编辑区域内的覆盖物的边框会变红, 表示该覆盖物被选中. 我们可以单击选中指定的覆盖物, 对应的编辑区域内的覆盖物的边框会变红, 表示该覆盖物被选中.
![选中覆盖物](public/selected.png) ![选中覆盖物](./public/selected.png)
:::tip :::tip
选中覆盖物后, 可以自由拖拽移动覆盖物. 选中覆盖物后, 可以自由拖拽移动覆盖物.

3
package.json

@ -8,7 +8,8 @@
"lint": "prettier --write \"src/**/*.{js,jsx,ts,tsx,json,less,md}\"", "lint": "prettier --write \"src/**/*.{js,jsx,ts,tsx,json,less,md}\"",
"docs:dev": "vitepress dev docs", "docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs", "docs:build": "vitepress build docs",
"docs:serve": "vitepress serve docs" "docs:serve": "vitepress serve docs",
"depoly": "npm run build && npm run docs:build && node depoly.js"
}, },
"dependencies": { "dependencies": {
"@finevis/emitter": "^1.0.4", "@finevis/emitter": "^1.0.4",

2
src/editor/Menu/Help.tsx

@ -77,7 +77,7 @@ const TableColumns = [
]; ];
const HelpMenu = () => { const HelpMenu = () => {
const onDocMenuClick = () => message.info("文档正在积极建设中"); const onDocMenuClick = () => window.open("/docs/", "_blank");
const [hotkeyModalVisible, setHotkeyModalVisible] = useState(false); const [hotkeyModalVisible, setHotkeyModalVisible] = useState(false);
return ( return (

3128
yarn.lock

File diff suppressed because it is too large Load Diff
Loading…
Cancel
Save