Skip to content

Commit

Permalink
docs: 更新文档链接 (#77)
Browse files Browse the repository at this point in the history
  • Loading branch information
gd4Ark authored Sep 18, 2020
1 parent 9735eff commit 1a41bf1
Show file tree
Hide file tree
Showing 47 changed files with 198 additions and 198 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Please make sure these boxes are checked before submitting your PR, thank you!

* [ ] Make sure you follow Element's contributing guide ([中文](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.zh-CN.md) | [English](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.en-US.md) | [Español](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.es.md) | [Français](https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.fr-FR.md)).
* [ ] Make sure you follow Element's contributing guide ([中文](https://github.com/femessage/element/blob/master/.github/CONTRIBUTING.zh-CN.md) | [English](https://github.com/femessage/element/blob/master/.github/CONTRIBUTING.en-US.md) | [Español](https://github.com/femessage/element/blob/master/.github/CONTRIBUTING.es.md) | [Français](https://github.com/femessage/element/blob/master/.github/CONTRIBUTING.fr-FR.md)).
* [ ] Make sure you are merging your commits to `dev` branch.
* [ ] Add some descriptions and refer relative issues for you PR.
6 changes: 3 additions & 3 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<details>
<summary>你们的文档怎么偷偷更新了?</summary>

我们只会在 Element 发布新版本时同步更新文档,以体现最新的变化。详细的更新内容可以查看 [changelog](https://github.com/ElemeFE/element/blob/master/CHANGELOG.zh-CN.md)
我们只会在 Element 发布新版本时同步更新文档,以体现最新的变化。详细的更新内容可以查看 [changelog](https://github.com/femessage/element/blob/master/CHANGELOG.zh-CN.md)
</details>

<details>
Expand Down Expand Up @@ -117,7 +117,7 @@
<details>
<summary>When do you update documentations of Element?</summary>

We update documentations only when a new version of Element is published so that it reflects all the changes introduced in that version. Updated changed can be found in the [changelog](https://github.com/ElemeFE/element/blob/master/CHANGELOG.en-US.md)
We update documentations only when a new version of Element is published so that it reflects all the changes introduced in that version. Updated changed can be found in the [changelog](https://github.com/femessage/element/blob/master/CHANGELOG.en-US.md)
</details>

<details>
Expand Down Expand Up @@ -191,7 +191,7 @@
<details>
<summary>¿Cuando añaden a la documentación de `Element`?</summary>

Añadamos la documentación con cada versión nueva de `Element` y los cambios reflejan los cambios del software de esa versión. Los cambios actuales y históricos se encuentran [aquí](https://github.com/ElemeFE/element/blob/master/CHANGELOG.en-US.md).
Añadamos la documentación con cada versión nueva de `Element` y los cambios reflejan los cambios del software de esa versión. Los cambios actuales y históricos se encuentran [aquí](https://github.com/femessage/element/blob/master/CHANGELOG.en-US.md).
</details>

<details>
Expand Down
12 changes: 6 additions & 6 deletions examples/components/footer.vue
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
<div class="container">
<div class="footer-main">
<h4>{{ langConfig.links }}</h4>
<a href="https://github.com/ElemeFE/element" class="footer-main-link" target="_blank">{{ langConfig.repo }}</a>
<a href="https://github.com/ElemeFE/element/releases" class="footer-main-link" target="_blank">{{ langConfig.changelog }}</a>
<a href="https://github.com/ElemeFE/element/blob/dev/FAQ.md" class="footer-main-link" target="_blank">{{ langConfig.faq }}</a>
<a href="https://github.com/femessage/element" class="footer-main-link" target="_blank">{{ langConfig.repo }}</a>
<a href="https://github.com/femessage/element/releases" class="footer-main-link" target="_blank">{{ langConfig.changelog }}</a>
<a href="https://github.com/femessage/element/blob/dev/FAQ.md" class="footer-main-link" target="_blank">{{ langConfig.faq }}</a>
<a href="https://github.com/ElementUI/element-starter" class="footer-main-link" target="_blank">{{ langConfig.starter }}</a>
<a :href="'/#/' + lang + '/component/custom-theme'" class="footer-main-link" target="_blank">{{ langConfig.theme }}</a>
<a href="https://github.com/elemefe/element-react" class="footer-main-link" target="_blank">Element-React</a>
Expand All @@ -14,8 +14,8 @@
<div class="footer-main">
<h4>{{ langConfig.community }}</h4>
<a :href="gitterLink" class="footer-main-link" target="_blank">{{ langConfig.gitter }}</a>
<a href="https://github.com/ElemeFE/element/issues" class="footer-main-link" target="_blank">{{ langConfig.feedback }}</a>
<a :href="`https://github.com/ElemeFE/element/blob/master/.github/CONTRIBUTING.${ lang }.md`" class="footer-main-link" target="_blank">{{ langConfig.contribution }}</a>
<a href="https://github.com/femessage/element/issues" class="footer-main-link" target="_blank">{{ langConfig.feedback }}</a>
<a :href="`https://github.com/femessage/element/blob/master/.github/CONTRIBUTING.${ lang }.md`" class="footer-main-link" target="_blank">{{ langConfig.contribution }}</a>
<a href="https://segmentfault.com/t/element-ui" class="footer-main-link" target="_blank">SegmentFault</a>
<a href="https://github.com/ElementUI/awesome-element" class="footer-main-link" target="_blank">Awesome Element</a>
</div>
Expand All @@ -31,7 +31,7 @@
<img src="../assets/images/qrcode.png" alt="">
</el-popover>
<i class="doc-icon-weixin elementdoc" v-popover:weixin></i>
<a href="https://github.com/elemefe" target="_blank">
<a href="https://github.com/femessage" target="_blank">
<i class="doc-icon-github elementdoc"></i>
</a>
<a :href="gitterLink" target="_blank">
Expand Down
2 changes: 1 addition & 1 deletion examples/components/side-nav.vue
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@
if (xhr.readyState === 4 && xhr.status === 200) {
const {data: navs} = JSON.parse(xhr.responseText);
this.femessageNavs = navs.map(nav => {
nav.url = `https://static.deepexi.top/serverless-console/index.html#/material/${nav.repoName}`;
nav.url = `https://frontend-infra.deepexi.com/home/index.html#/material/${nav.repoName}`;
return nav;
}).filter(nav => nav.lib && nav.lib.indexOf('element') > -1);
}
Expand Down
8 changes: 4 additions & 4 deletions examples/docs/en-US/custom-theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ The above website enables you to preview theme of a new theme color in real-time
$--color-primary: teal;

/* icon font path, required */
$--font-path: '~element-ui/lib/theme-chalk/fonts';
$--font-path: '~@femessage/element-ui/lib/theme-chalk/fonts';

@import "~element-ui/packages/theme-chalk/src/index";
@import "~@femessage/element-ui/packages/theme-chalk/src/index";
```

Then in the entry file of your project, import this style file instead of Element's built CSS:
```JS
import Vue from 'vue'
import Element from 'element-ui'
import Element from '@femessage/element-ui'
import './element-variables.scss'

Vue.use(Element)
Expand Down Expand Up @@ -107,7 +107,7 @@ Importing your own theme is just like importing the default theme, only this tim

```javascript
import '../theme/index.css'
import ElementUI from 'element-ui'
import ElementUI from '@femessage/element-ui'
import Vue from 'vue'

Vue.use(ElementUI)
Expand Down
48 changes: 24 additions & 24 deletions examples/docs/en-US/i18n.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ The default language of Element is Chinese. If you wish to use another language,

```javascript
import Vue from 'vue'
import ElementUI from 'element-ui'
import locale from 'element-ui/lib/locale/lang/en'
import ElementUI from '@femessage/element-ui'
import locale from '@femessage/element-ui/lib/locale/lang/en'

Vue.use(ElementUI, { locale })
```
Expand All @@ -14,9 +14,9 @@ Or if you are importing Element on demand:

```javascript
import Vue from 'vue'
import { Button, Select } from 'element-ui'
import lang from 'element-ui/lib/locale/lang/en'
import locale from 'element-ui/lib/locale'
import { Button, Select } from '@femessage/element-ui'
import lang from '@femessage/element-ui/lib/locale/lang/en'
import locale from '@femessage/element-ui/lib/locale'

// configure language
locale.use(lang)
Expand All @@ -32,7 +32,7 @@ webpack.config.js
```javascript
{
plugins: [
new webpack.NormalModuleReplacementPlugin(/element-ui[\/\\]lib[\/\\]locale[\/\\]lang[\/\\]zh-CN/, 'element-ui/lib/locale/lang/en')
new webpack.NormalModuleReplacementPlugin(/@femessage[\/\\]element-ui[\/\\]lib[\/\\]locale[\/\\]lang[\/\\]zh-CN/, '@femessage/element-ui/lib/locale/lang/en')
]
}
```
Expand All @@ -44,9 +44,9 @@ Element is compatible with [vue-i18n@5.x](https://github.com/kazupon/vue-i18n),
```javascript
import Vue from 'vue'
import VueI18n from 'vue-i18n'
import Element from 'element-ui'
import enLocale from 'element-ui/lib/locale/lang/en'
import zhLocale from 'element-ui/lib/locale/lang/zh-CN'
import Element from '@femessage/element-ui'
import enLocale from '@femessage/element-ui/lib/locale/lang/en'
import zhLocale from '@femessage/element-ui/lib/locale/lang/zh-CN'

Vue.use(VueI18n)
Vue.use(Element)
Expand All @@ -61,9 +61,9 @@ Element may not be compatible with i18n plugins other than vue-i18n, but you can

```javascript
import Vue from 'vue'
import Element from 'element-ui'
import enLocale from 'element-ui/lib/locale/lang/en'
import zhLocale from 'element-ui/lib/locale/lang/zh-CN'
import Element from '@femessage/element-ui'
import enLocale from '@femessage/element-ui/lib/locale/lang/en'
import zhLocale from '@femessage/element-ui/lib/locale/lang/zh-CN'

Vue.use(Element, {
i18n: function (path, options) {
Expand All @@ -78,10 +78,10 @@ You need to manually handle it for compatibility with `6.x`.

```javascript
import Vue from 'vue'
import Element from 'element-ui'
import Element from '@femessage/element-ui'
import VueI18n from 'vue-i18n'
import enLocale from 'element-ui/lib/locale/lang/en'
import zhLocale from 'element-ui/lib/locale/lang/zh-CN'
import enLocale from '@femessage/element-ui/lib/locale/lang/en'
import zhLocale from '@femessage/element-ui/lib/locale/lang/zh-CN'

Vue.use(VueI18n)

Expand Down Expand Up @@ -115,9 +115,9 @@ import Vue from 'vue'
import DatePicker from 'element/lib/date-picker'
import VueI18n from 'vue-i18n'

import enLocale from 'element-ui/lib/locale/lang/en'
import zhLocale from 'element-ui/lib/locale/lang/zh-CN'
import ElementLocale from 'element-ui/lib/locale'
import enLocale from '@femessage/element-ui/lib/locale/lang/en'
import zhLocale from '@femessage/element-ui/lib/locale/lang/zh-CN'
import ElementLocale from '@femessage/element-ui/lib/locale'

Vue.use(VueI18n)
Vue.use(DatePicker)
Expand Down Expand Up @@ -145,8 +145,8 @@ ElementLocale.i18n((key, value) => i18n.t(key, value))

```html
<script src="//unpkg.com/vue"></script>
<script src="//unpkg.com/element-ui"></script>
<script src="//unpkg.com/element-ui/lib/umd/locale/en.js"></script>
<script src="//unpkg.com/@femessage/element-ui"></script>
<script src="//unpkg.com/@femessage/element-ui/lib/umd/locale/en.js"></script>

<script>
ELEMENT.locale(ELEMENT.lang.en)
Expand All @@ -158,9 +158,9 @@ Compatible with `vue-i18n`
```html
<script src="//unpkg.com/vue"></script>
<script src="//unpkg.com/vue-i18n/dist/vue-i18n.js"></script>
<script src="//unpkg.com/element-ui"></script>
<script src="//unpkg.com/element-ui/lib/umd/locale/zh-CN.js"></script>
<script src="//unpkg.com/element-ui/lib/umd/locale/en.js"></script>
<script src="//unpkg.com/@femessage/element-ui"></script>
<script src="//unpkg.com/@femessage/element-ui/lib/umd/locale/zh-CN.js"></script>
<script src="//unpkg.com/@femessage/element-ui/lib/umd/locale/en.js"></script>

<script>
Vue.locale('en', ELEMENT.lang.en)
Expand Down Expand Up @@ -223,4 +223,4 @@ Currently Element ships with the following languages:
<li>Esperanto (eo)</li>
</ul>

If your target language is not included, you are more than welcome to contribute: just add another language config [here](https://github.com/ElemeFE/element/tree/dev/src/locale/lang) and create a pull request.
If your target language is not included, you are more than welcome to contribute: just add another language config [here](https://github.com/femessage/element/tree/dev/src/locale/lang) and create a pull request.
6 changes: 3 additions & 3 deletions examples/docs/en-US/input.md
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ You can get some recommended tips based on the current input.
loadAll() {
return [
{ "value": "vue", "link": "https://github.com/vuejs/vue" },
{ "value": "element", "link": "https://github.com/ElemeFE/element" },
{ "value": "element", "link": "https://github.com/femessage/element" },
{ "value": "cooking", "link": "https://github.com/ElemeFE/cooking" },
{ "value": "mint-ui", "link": "https://github.com/ElemeFE/mint-ui" },
{ "value": "vuex", "link": "https://github.com/vuejs/vuex" },
Expand Down Expand Up @@ -439,7 +439,7 @@ Customize how suggestions are displayed.
loadAll() {
return [
{ "value": "vue", "link": "https://github.com/vuejs/vue" },
{ "value": "element", "link": "https://github.com/ElemeFE/element" },
{ "value": "element", "link": "https://github.com/femessage/element" },
{ "value": "cooking", "link": "https://github.com/ElemeFE/cooking" },
{ "value": "mint-ui", "link": "https://github.com/ElemeFE/mint-ui" },
{ "value": "vuex", "link": "https://github.com/vuejs/vuex" },
Expand Down Expand Up @@ -487,7 +487,7 @@ Search data from server-side.
loadAll() {
return [
{ "value": "vue", "link": "https://github.com/vuejs/vue" },
{ "value": "element", "link": "https://github.com/ElemeFE/element" },
{ "value": "element", "link": "https://github.com/femessage/element" },
{ "value": "cooking", "link": "https://github.com/ElemeFE/cooking" },
{ "value": "mint-ui", "link": "https://github.com/ElemeFE/mint-ui" },
{ "value": "vuex", "link": "https://github.com/vuejs/vuex" },
Expand Down
6 changes: 3 additions & 3 deletions examples/docs/en-US/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ npm i element-ui -S

### CDN

Get the latest version from [unpkg.com/element-ui](https://unpkg.com/element-ui/) , and import JavaScript and CSS file in your page.
Get the latest version from [unpkg.com/element-ui](https://unpkg.com/@femessage/element-ui/) , and import JavaScript and CSS file in your page.

```html
<!-- import CSS -->
<link rel="stylesheet" href="https://unpkg.com/element-ui/lib/theme-chalk/index.css">
<link rel="stylesheet" href="https://unpkg.com/@femessage/element-ui/lib/theme-chalk/index.css">
<!-- import JavaScript -->
<script src="https://unpkg.com/element-ui/lib/index.js"></script>
<script src="https://unpkg.com/@femessage/element-ui/lib/index.js"></script>
```

:::tip
Expand Down
2 changes: 1 addition & 1 deletion examples/docs/en-US/layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ Taking example by Bootstrap's responsive design, five breakpoints are preset: xs
Additionally, Element provides a series of classes for hiding elements under certain conditions. These classes can be added to any DOM elements or custom components. You need to import the following CSS file to use these classes:

```js
import 'element-ui/lib/theme-chalk/display.css';
import '@femessage/element-ui/lib/theme-chalk/display.css';
```

The classes are:
Expand Down
2 changes: 1 addition & 1 deletion examples/docs/en-US/loading.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Show a full screen animation while loading data.
### Service
You can also invoke Loading with a service. Import Loading service:
```javascript
import { Loading } from 'element-ui';
import { Loading } from '@femessage/element-ui';
```
Invoke it:
```javascript
Expand Down
4 changes: 2 additions & 2 deletions examples/docs/en-US/message-box.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ Can be customized to show various content.
:::

:::tip
The content of MessageBox can be `VNode`, allowing us to pass custom components. When opening the MessageBox, Vue compares new `VNode` with old `VNode`, then figures out how to efficiently update the UI, so the components may not be completely re-rendered ([#8931](https://github.com/ElemeFE/element/issues/8931)). In this case, you can add a unique key to `VNode` each time MessageBox opens: [example](https://jsfiddle.net/zhiyang/ezmhq2ef).
The content of MessageBox can be `VNode`, allowing us to pass custom components. When opening the MessageBox, Vue compares new `VNode` with old `VNode`, then figures out how to efficiently update the UI, so the components may not be completely re-rendered ([#8931](https://github.com/femessage/element/issues/8931)). In this case, you can add a unique key to `VNode` each time MessageBox opens: [example](https://jsfiddle.net/zhiyang/ezmhq2ef).
:::

### Use HTML String
Expand Down Expand Up @@ -288,7 +288,7 @@ If Element is fully imported, it will add the following global methods for Vue.p
If you prefer importing `MessageBox` on demand:

```javascript
import { MessageBox } from 'element-ui';
import { MessageBox } from '@femessage/element-ui';
```

The corresponding methods are: `MessageBox`, `MessageBox.alert`, `MessageBox.confirm` and `MessageBox.prompt`. The parameters are the same as above.
Expand Down
2 changes: 1 addition & 1 deletion examples/docs/en-US/message.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ Element has added a global method `$message` for Vue.prototype. So in a vue inst
Import `Message`:

```javascript
import { Message } from 'element-ui';
import { Message } from '@femessage/element-ui';
```

In this case you should call `Message(options)`. We have also registered methods for different types, e.g. `Message.success(options)`. You can call `Message.closeAll()` to manually close all the instances.
Expand Down
2 changes: 1 addition & 1 deletion examples/docs/en-US/notification.md
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ Element has added a global method `$notify` for Vue.prototype. So in a vue insta
Import `Notification`:

```javascript
import { Notification } from 'element-ui';
import { Notification } from '@femessage/element-ui';
```

In this case you should call `Notification(options)`. We have also registered methods for different types, e.g. `Notification.success(options)`. You can call `Notification.closeAll()` to manually close all the instances.
Expand Down
14 changes: 7 additions & 7 deletions examples/docs/en-US/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ In main.js:

```javascript
import Vue from 'vue';
import ElementUI from 'element-ui';
import 'element-ui/lib/theme-chalk/index.css';
import ElementUI from '@femessage/element-ui';
import '@femessage/element-ui/lib/theme-chalk/index.css';
import App from './App.vue';

Vue.use(ElementUI);
Expand Down Expand Up @@ -67,7 +67,7 @@ Next, if you need Button and Select, edit main.js:

```javascript
import Vue from 'vue';
import { Button, Select } from 'element-ui';
import { Button, Select } from '@femessage/element-ui';
import App from './App.vue';

Vue.component(Button.name, Button);
Expand All @@ -83,7 +83,7 @@ new Vue({
});
```

Full example (Component list reference [components.json](https://github.com/ElemeFE/element/blob/master/components.json))
Full example (Component list reference [components.json](https://github.com/femessage/element/blob/master/components.json))

```javascript
import Vue from 'vue';
Expand Down Expand Up @@ -165,7 +165,7 @@ import {
MessageBox,
Message,
Notification
} from 'element-ui';
} from '@femessage/element-ui';

Vue.use(Pagination);
Vue.use(Dialog);
Expand Down Expand Up @@ -260,15 +260,15 @@ Fully import Element:

```js
import Vue from 'vue';
import Element from 'element-ui';
import Element from '@femessage/element-ui';
Vue.use(Element, { size: 'small', zIndex: 3000 });
```

Partial import Element:

```js
import Vue from 'vue';
import { Button } from 'element-ui';
import { Button } from '@femessage/element-ui';

Vue.prototype.$ELEMENT = { size: 'small', zIndex: 3000 };
Vue.use(Button);
Expand Down
4 changes: 2 additions & 2 deletions examples/docs/en-US/transition.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,9 @@ For collapse effect, use the `el-collapse-transition` component.

```js
// fade/zoom
import 'element-ui/lib/theme-chalk/base.css';
import '@femessage/element-ui/lib/theme-chalk/base.css';
// collapse
import CollapseTransition from 'element-ui/lib/transitions/collapse-transition';
import CollapseTransition from '@femessage/element-ui/lib/transitions/collapse-transition';
import Vue from 'vue'

Vue.component(CollapseTransition.name, CollapseTransition)
Expand Down
Loading

0 comments on commit 1a41bf1

Please sign in to comment.