diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js new file mode 100644 index 0000000..595856d --- /dev/null +++ b/docs/.vitepress/config.js @@ -0,0 +1,31 @@ +module.exports = { + title: 'Fine-GeoJSON-Editor', + description: '在线geojson编辑器.', + base: "/docs/", + themeConfig: { + sidebarDepth: 3, + sidebar: { + collapsable: false, + "/": [ + { + title: "", + collapsable: false, + children: [ + { + link: "/index", + text: "介绍" + }, + { + link: "/start", + text: "开始使用" + }, + { + link: "/changelog", + text: "更新日志" + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..1ab4970 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1 @@ +# 更新日志 \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..b2c4edc --- /dev/null +++ b/docs/index.md @@ -0,0 +1,5 @@ +# 介绍 + +> Fine-GeoJSON-Editor 是一款基于高德JS API开发的geojson编辑器. +> +> 旨在提供更便捷的geojson编辑功能. \ No newline at end of file diff --git a/docs/start.md b/docs/start.md new file mode 100644 index 0000000..3ff9754 --- /dev/null +++ b/docs/start.md @@ -0,0 +1,13 @@ +# 开始使用 + +## 菜单 +### 文件 +### 编辑 +### 帮助 + +## 主编辑区 + + +## 图层目录 + +## 图层属性 \ No newline at end of file diff --git a/package.json b/package.json index a68ff34..159537a 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,10 @@ "dev": "vite", "build": "vite build", "preview": "vite preview", - "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:build": "vitepress build docs", + "docs:serve": "vitepress serve docs" }, "dependencies": { "@finevis/emitter": "^1.0.4",