帮助

# 快速上手

# 安装依赖

前提条件

需要 Node.js (opens new window)>= 8.6

使用 yarn 安装依赖

yarn install --registry=http://atlas.geoway.com.cn/nexus/repository/npm-geoway/
1

使用 npm 安装依赖

npm install --registry=http://atlas.geoway.com.cn/nexus/repository/npm-geoway/
1

# 创建你的第一篇文档

  1. 在 docs 中创建md文档

README.md 为当前目录的默认页面, 如果为docs/README.md 则为首页

需将md文档创建在dev-support中对应的文件加中 README.md 为当前目录下的默认页面

例如 docs/dev-support/map-sdk/android/README.md 的访问路径为 http://ip:port/atlas-docs/dev-support/map-sdk/android/

mkdir docs/dev-support && echo '# Hello VuePress' > docs/README.md
1

注意

每个 md 文档都相当于一个独立的页面,页面内的主题组件显示都是可配置的

# 配置当前页面

md文档配置详情

#在md文档的头部，使用 --- 包裹配置信息
#必须采用在三点划线之间书写的有效的 YAML
---
title: 当前页面标题
---
1
2
3
4
5

# 在本地启动服务器

yarn docs:dev # npm run docs:dev
1

项目 会在 http://localhost:8080 (opens new window) (opens new window)启动一个热重载的开发服务器。

接下来，了解一下推荐的 目录结构 和 基本配置。

等你了解完上文介绍的基础概念，再去学习一下如何使用 静态资源，Markdown 拓展 和 在 Markdown 中使用 Vue 来丰富你的文档内容。

← 目录结构 →