🆕 添加文档地址,优化文档样式

This commit is contained in:
xujiang 2021-01-17 23:22:04 +08:00
parent 51f83bf7a5
commit fe7cebf505
7 changed files with 2703 additions and 118 deletions

View File

@ -1,5 +1,5 @@
module.exports = { module.exports = {
base: '/', base: '/doc/',
title: 'h5-dooring', title: 'h5-dooring',
dest: './doc-dist', dest: './doc-dist',
themeConfig: { themeConfig: {
@ -7,10 +7,11 @@ module.exports = {
searchMaxSuggestions: 10, searchMaxSuggestions: 10,
lastUpdated: 'Last Updated', lastUpdated: 'Last Updated',
nav: [ nav: [
{ text: '体验', link: '/' }, { text: '首页', link: '/' },
{ text: '文档', link: '/zh/guide/' }, { text: '文档', link: '/zh/guide/' },
{ text: '1.X', link: '/zh/guide/1' }, // { text: '1.X', link: '/zh/guide/' },
{ text: '语言', link: '/zh/guide/2' }, // { text: '语言', link: '/zh/guide/' },
{ text: '体验', link: 'http://h5.dooring.cn' },
{ text: 'github', link: 'https://github.com/MrXujiang/h5-Dooring' }, { text: 'github', link: 'https://github.com/MrXujiang/h5-Dooring' },
], ],
sidebar: [ sidebar: [

View File

@ -1,56 +1,56 @@
<template> <template>
<main class="home" :aria-labelledby="data.heroText !== null ? 'main-title' : null"> <main class="home" :aria-labelledby="data.heroText !== null ? 'main-title' : null">
<header class="hero"> <header class="hero">
<h1 v-if="data.heroText !== null" id="main-title"> <h1 v-if="data.heroText !== null" id="main-title">
<img src="../imgs/common/logo.svg" :alt="data.heroAlt || 'hero'" /><span>{{ <img src="../imgs/common/logo.svg" :alt="data.heroAlt || 'hero'" /><span>{{
data.heroText || $title || "Hello" data.heroText || $title || "Hello"
}}</span> }}</span>
</h1> </h1>
</header> </header>
<div v-if="data.features && data.features.length" class="features"> <div v-if="data.features && data.features.length" class="features">
<div class="container"> <div class="container">
<div v-for="(feature, index) in data.features" :key="index" class="feature"> <div v-for="(feature, index) in data.features" :key="index" class="feature">
<div class="feature-index">{{ index + 1 }}</div> <div class="feature-index">{{ index + 1 }}</div>
<h2>{{ feature.title }}</h2> <h2>{{ feature.title }}</h2>
<p>{{ feature.details }}</p> <p>{{ feature.details }}</p>
</div>
</div>
</div> </div>
</div>
</div>
<Content class="theme-default-content custom" /> <Content class="theme-default-content custom" />
<div class="hero"> <div class="hero">
<p v-if="data.actionText && data.actionLink" class="action"> <p v-if="data.actionText && data.actionLink" class="action">
<NavLink class="action-button" :item="actionLink" /> <NavLink class="action-button" :item="actionLink" />
</p> </p>
</div> </div>
<div v-if="data.footer" class="footer"> <div v-if="data.footer" class="footer">
{{ data.footer }} {{ data.footer }}
</div> </div>
</main> </main>
</template> </template>
<script> <script>
import NavLink from "@vuepress/theme-default/components/NavLink.vue"; import NavLink from "@vuepress/theme-default/components/NavLink.vue";
export default { export default {
name: "Home", name: "Home",
components: { NavLink }, components: { NavLink },
computed: { computed: {
data() { data() {
return this.$page.frontmatter; return this.$page.frontmatter;
},
actionLink() {
return {
link: this.data.actionLink,
text: this.data.actionText,
};
},
}, },
actionLink() {
return {
link: this.data.actionLink,
text: this.data.actionText,
};
},
},
}; };
</script> </script>
@ -101,7 +101,7 @@ $homePageWidth = 1080px
background-color lighten($accentColor, 10%) background-color lighten($accentColor, 10%)
.features .features
border-top 1px solid $borderColor border-top 1px solid $borderColor
padding 1.2rem 0 padding 80px 0
background-color #fff background-color #fff
margin-top 2.5rem margin-top 2.5rem
.container .container
@ -116,7 +116,7 @@ $homePageWidth = 1080px
max-width 27% max-width 27%
border-radius 8px border-radius 8px
padding 20px 22px padding 20px 22px
box-shadow 0 5px 4px 4px #ddd box-shadow 0 0 8px rgba(0,0,0,.1)
.feature-index .feature-index
border-radius 4px border-radius 4px
background-color #083ac4 background-color #083ac4

View File

@ -7,10 +7,10 @@ features:
- title: 简洁方便 - title: 简洁方便
details: 任何人只需傻瓜式拖拽或进行简单编辑即可生成精美的H5页面 details: 任何人只需傻瓜式拖拽或进行简单编辑即可生成精美的H5页面
- title: 插拔式体验 - title: 插拔式体验
details: 产品以GPL协议开源可植入任何系统,并支持二次开发 details: 产品以GPL协议开源, 授权后可植入任何系统,并支持二次开发
- title: 持续迭代,无限可能 - title: 持续迭代,无限可能
details: 目前正在持续迭代中,后续可根据需求开发功能更强大的可视化系统 details: 目前正在持续迭代中,后续可根据需求开发功能更强大的可视化系统
actionText: 快速上手 → actionText: 快速上手 →
actionLink: /zh/guide/ actionLink: /zh/guide/
footer: GPL Licensed | Copyright © 2018-present Dooring footer: GPL Licensed | Copyright © 2020-present H5-Dooring
--- ---

2
doc/zh/guide/building.md Normal file
View File

@ -0,0 +1,2 @@
正在建设中...

View File

@ -18,7 +18,6 @@
], ],
"contributors": [ "contributors": [
"徐小夕 <xujiang156@qq.com> (https://github.com/MrXujiang))", "徐小夕 <xujiang156@qq.com> (https://github.com/MrXujiang))",
"dragon <zhangjinlongll@163.com> (https://github.com/zhangjinlongll))",
"yehuozhili <yehuozhili@outlook.com> (https://github.com/yehuozhili))" "yehuozhili <yehuozhili@outlook.com> (https://github.com/yehuozhili))"
], ],
"scripts": { "scripts": {
@ -46,7 +45,7 @@
"prettier --parser=typescript --write" "prettier --parser=typescript --write"
] ]
}, },
"homepage": "http://io.nainor.com/h5_visible", "homepage": "http://h5.dooring.cn",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/MrXujiang/h5-Dooring.git" "url": "git+https://github.com/MrXujiang/h5-Dooring.git"

View File

@ -16,20 +16,22 @@
> H5-Dooring is a powerful, open source, free H5 visual page configuration solution dedicated to providing a simple, convenient, professional and reliable, unlimited set of H5 landing page best practices. The technology stack is mainly react, developed in the background using nodejs. > H5-Dooring is a powerful, open source, free H5 visual page configuration solution dedicated to providing a simple, convenient, professional and reliable, unlimited set of H5 landing page best practices. The technology stack is mainly react, developed in the background using nodejs.
### 🏠 [Homepage](http://49.234.61.19/h5_visible) ### 🏠 [Homepage](http://h5.dooring.cn)
### ✨ [Demo](http://h5.dooring.cn/h5_plus/editor?tid=123456) ### ✨ [Demo](http://h5.dooring.cn/h5_plus/editor?tid=123456)
### 📦 doc(文档) [H5-Dooring Document](http://h5.dooring.cn/doc)
### [视频教程 | Video tutorial](https://www.zhihu.com/zvideo/1326300284608417792) ### [视频教程 | Video tutorial](https://www.zhihu.com/zvideo/1326300284608417792)
<!-- <img src="http://io.nainor.com/uploads/face_17512320c6d.png" alt="H5可视化编辑器" /> --> <!-- <img src="http://io.nainor.com/uploads/face_17512320c6d.png" alt="H5可视化编辑器" /> -->
![](http://49.234.61.19/uploads/dooring-sdk_1763cbe7028.png) ![](http://h5.dooring.cn/uploads/dooring-sdk_1763cbe7028.png)
## Author ## Author
👤 **徐小夕** 👤 **徐小夕**
* Website: http://49.234.61.19/h5_visible * Website: http://h5.dooring.cn
* Github: [@MrXujiang](https://github.com/MrXujiang) * Github: [@MrXujiang](https://github.com/MrXujiang)
## 🤝 Contributing ## 🤝 Contributing
@ -44,13 +46,13 @@ Give a ⭐️ if this project helped you!
最近笔者正在开放dooring的插拔式服务, 以js-sdk的形式支持集成到外部系统中, 并提供开放API共使用者自由配置. 规划如下: 最近笔者正在开放dooring的插拔式服务, 以js-sdk的形式支持集成到外部系统中, 并提供开放API共使用者自由配置. 规划如下:
![](http://49.234.61.19/uploads/sdk_1763cc11bd5.png) ![](http://h5.dooring.cn/uploads/sdk_1763cc11bd5.png)
### 1. 如何引用用js-sdk | How to use js-sdk ### 1. 如何引用用js-sdk | How to use js-sdk
我们可以使用两种方式来使用我们的js-sdk, 第一种是在项目脚本中引入如下script标签, 如下: 我们可以使用两种方式来使用我们的js-sdk, 第一种是在项目脚本中引入如下script标签, 如下:
``` js ``` js
<script src="http://49.234.61.19/dooring-sdk.js"></script> <script src="http://h5.dooring.cn/dooring-sdk.js"></script>
``` ```
或者直接复制如下代码到你的script标签中, 代码如下: 或者直接复制如下代码到你的script标签中, 代码如下:
``` js ``` js

2709
yarn.lock

File diff suppressed because it is too large Load Diff