docs: improve code comments (#1911)

This commit is contained in:
花裤衩
2019-04-16 11:20:13 +08:00
committed by GitHub
parent 26d0f40df2
commit be7ec4c0ff
49 changed files with 134 additions and 138 deletions

View File

@@ -1,9 +1,9 @@
<template>
<div class="components-container">
<code>This is based on
<aside>This is based on
<a class="link-type" href="//github.com/dai-siki/vue-image-crop-upload"> vue-image-crop-upload</a>.
{{ $t('components.imageUploadTips') }}
</code>
</aside>
<pan-thumb :image="image" />

View File

@@ -1,7 +1,7 @@
<template>
<div class="components-container">
<code>{{ $t('components.backToTopTips1') }}</code>
<code>{{ $t('components.backToTopTips2') }}</code>
<aside>{{ $t('components.backToTopTips1') }}</aside>
<aside>{{ $t('components.backToTopTips2') }}</aside>
<div class="placeholder-container">
<div>placeholder</div>
<div>placeholder</div>
@@ -113,8 +113,7 @@
<div>placeholder</div>
<div>placeholder</div>
</div>
<!--可自定义按钮的样式show/hide临界点返回的位置 -->
<!--如需文字提示可在外部添加element的<el-tooltip></el-tooltip>元素 -->
<!-- you can add element-ui's tooltip -->
<el-tooltip placement="top" content="tooltip">
<back-to-top :custom-style="myBackToTopStyle" :visibility-height="300" :back-position="50" transition-name="fade" />
</el-tooltip>
@@ -129,6 +128,7 @@ export default {
components: { BackToTop },
data() {
return {
// customizable button style, show/hide critical point, return position
myBackToTopStyle: {
right: '50px',
bottom: '50px',

View File

@@ -1,8 +1,8 @@
<template>
<div class="components-container">
<p class="warn-content">
<aside>
<a href="https://github.com/PanJiaChen/vue-countTo" target="_blank">countTo-component</a>
</p>
</aside>
<count-to
ref="example"
:start-val="_startVal"
@@ -45,9 +45,9 @@
<input v-model="setSuffix" name="suffixInput">
</label>
</div>
<code>&lt;count-to :start-val=&#x27;{{ _startVal }}&#x27; :end-val=&#x27;{{ _endVal }}&#x27; :duration=&#x27;{{ _duration }}&#x27;
<aside>&lt;count-to :start-val=&#x27;{{ _startVal }}&#x27; :end-val=&#x27;{{ _endVal }}&#x27; :duration=&#x27;{{ _duration }}&#x27;
:decimals=&#x27;{{ _decimals }}&#x27; :separator=&#x27;{{ _separator }}&#x27; :prefix=&#x27;{{ _prefix }}&#x27; :suffix=&#x27;{{ _suffix }}&#x27;
:autoplay=false&gt;</code>
:autoplay=false&gt;</aside>
</div>
</template>

View File

@@ -1,8 +1,8 @@
<template>
<div class="components-container">
<code>drag-list base on
<aside>drag-list base on
<a href="https://github.com/SortableJS/Vue.Draggable" target="_blank">Vue.Draggable</a>
</code>
</aside>
<div class="editor-container">
<dnd-list :list1="list1" :list2="list2" list1-title="List" list2-title="Article pool" />
</div>

View File

@@ -1,9 +1,9 @@
<template>
<div class="components-container">
<code>
<aside>
Based on <a class="link-type" href="https://github.com/rowanwins/vue-dropzone"> dropzone </a>.
{{ $t('components.dropzoneTips') }}
</code>
</aside>
<div class="editor-container">
<dropzone id="myVueDropzone" url="https://httpbin.org/post" @dropzone-removedFile="dropzoneR" @dropzone-success="dropzoneS" />
</div>

View File

@@ -1,10 +1,10 @@
<template>
<div class="components-container">
<code>Json-Editor is base on <a href="https://github.com/codemirror/CodeMirror" target="_blank">CodeMirrorr</a>. Lint
<aside>Json-Editor is base on <a href="https://github.com/codemirror/CodeMirror" target="_blank">CodeMirrorr</a>. Lint
base on <a
href="https://github.com/codemirror/CodeMirror/blob/master/addon/lint/json-lint.js"
target="_blank"
>json-lint</a>.</code>
>json-lint</a>.</aside>
<div class="editor-container">
<json-editor ref="jsonEditor" v-model="value" />
</div>

View File

@@ -1,13 +1,13 @@
<template>
<div class="components-container">
<code>Markdown is based on
<aside>Markdown is based on
<a href="https://github.com/nhnent/tui.editor" target="_blank">tui.editor</a> simply wrapped with Vue.
<a
target="_blank"
href="https://panjiachen.github.io/vue-element-admin-site/feature/component/markdown-editor.html"
>
Documentation </a>
</code>
</aside>
<div class="editor-container">
<el-tag class="tag-title">

View File

@@ -1,10 +1,10 @@
<template>
<div class="components-container">
<code><strong>SplitPane</strong> If you've used
<aside><strong>SplitPane</strong> If you've used
<a href="https://codepen.io/" target="_blank"> codepen</a>,
<a href="https://jsfiddle.net/" target="_blank"> jsfiddle </a>will not be unfamiliar.
<a href="https://github.com/PanJiaChen/vue-split-pane" target="_blank"> Github repository</a>
</code>
</aside>
<split-pane split="vertical" @resize="resize">
<template slot="paneL">
<div class="left-container" />

View File

@@ -37,7 +37,7 @@
</sticky>
<div class="components-container">
<code>Sticky header, {{ $t('components.stickyTips') }}</code>
<aside>Sticky header, {{ $t('components.stickyTips') }}</aside>
<div>placeholder</div>
<div>placeholder</div>
<div>placeholder</div>

View File

@@ -1,9 +1,9 @@
<template>
<div class="components-container">
<code>
<aside>
{{ $t('components.tinymceTips') }}
<a target="_blank" class="link-type" href="https://panjiachen.github.io/vue-element-admin-site/component/rich-editor.html"> {{ $t('components.documentation') }}</a>
</code>
</aside>
<div>
<tinymce v-model="content" :height="300" />
</div>