Skip to content

Commit

Permalink
文档::文档编写指南
Browse files Browse the repository at this point in the history
  • Loading branch information
oovm committed Jul 16, 2018
1 parent 1f3737c commit 7194685
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 12 deletions.
7 changes: 3 additions & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
sudo: required
dist: trusty
branches:
only:
- master
# 只需要自定义下面五个量
env:
global:
Expand All @@ -26,7 +23,9 @@ script:
- nVer=`echo $ver | awk -F. '{printf "%s.%s.%s\n",$1,$2,$3+1}'`
- echo $nVer
before_deploy:
- rm -rf .*
- rm -rf .git*
- rm -rf .editorconfig
- rm -rf .travis.yml
- rm -rf *.json
- rm -rf yarn.lock
- rm -rf docs
Expand Down
3 changes: 2 additions & 1 deletion docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ module.exports = {
title: '简介',
children: [
'/Start/',
'/Start/Design.md'
'/Start/Design.md',
'/Start/Guide.md'
]
},
{
Expand Down
5 changes: 5 additions & 0 deletions docs/Crawler/Guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# 文档编写指南

本文档使用 vuepress 编写

注意使用CRLF
47 changes: 40 additions & 7 deletions docs/Toys/Readme.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,56 @@
# 其他图片类功能

## Logo

![20180716080321085.png](https://i.loli.net/2018/07/16/5b4c8b58a92ba.png)
#### `HeaderLogo[]`

文件名为哈希

![Logo.png](https://i.loli.net/2018/07/16/5b4c8b58a92ba.png)

#### `HeaderBanner[path_String]`

path 为上面输出的路径, 将下载的版头制成拼图.

可选项 `Path`, 指定输出目录

## Banner

![20180716080220430.png](https://i.loli.net/2018/07/16/5b4c8b5979070.png)
#### `HeaderBanner[]`

获取版头

可选项 `Path`, 指定输出目录

![Banner.png](https://i.loli.net/2018/07/16/5b4c8b5979070.png)

#### `HeaderBanner[path_String]`

path 为上面输出的路径, 将下载的版头制成拼图.

可选项 `Path`, 指定输出目录

## IndexIcon


### `IndexIcon[]`
![20180716080123956.png](https://i.loli.net/2018/07/16/5b4c8b587b59e.png)
#### `IndexIcon[]`
![IndexIcon.png](https://i.loli.net/2018/07/16/5b4c8b587b59e.png)


#### `IndexIcon["Markdown"]`

### `IndexIcon["Markdown"]`
导出一个 markdown 文档

![20180716075211684.png](https://i.loli.net/2018/07/16/5b4c8b5761336.png)
![IndexIcon.png](https://i.loli.net/2018/07/16/5b4c8b5761336.png)

## ErrorPage

#### `ErrorPage[]`


## Emoji

![20180716080351343.png](https://i.loli.net/2018/07/16/5b4c8b597585a.png)
#### `VipEmoji[]`


![Emoji.png](https://i.loli.net/2018/07/16/5b4c8b597585a.png)

0 comments on commit 7194685

Please sign in to comment.