文档编辑指南

新增一个 markdown 文件

contents/zh/(中文文章)或 contents/en/(英文文章)目录下新增一个 markdown 文件,最多支持三级目录。将路径及标题信息更新在 contents/zh/posts.ymlcontents/en/posts.yml

markdown 文件名称小写。

使用 prettier 来自动格式化代码

在开始之前,我们推荐安装prettierVSCode 插件,该插件可以在你保存的时候自动帮你格式化代码。

如果你觉得自动的格式化破坏了你的代码块,你可以在在代码块外面加上下面代码阻止prettier格式化该部分代码

<!-- prettier-ignore-start -->
<!-- prettier-ignore-end -->

如果你发现有的代码块并没有被格式化,请先检查该代码是否存在语法上的错误。

内置变量

  • optionPath
  • mainSitePath
  • exampleViewPath
  • exampleEditorPath
  • lang

使用方式:

${xxxxx}

引用其它文章

[获取 Apache ECharts](${lang}/basics/download)

获取 Apache ECharts

引用代码

基础使用

```js
option = {
    series: [{
        type: 'bar',
        data: [23, 24, 18, 25, 27, 28, 25]
    }]
};
\```
option = {
  series: [
    {
      type: 'bar',
      data: [23, 24, 18, 25, 27, 28, 25]
    }
  ]
};

代码推荐写法

为了可以让工具帮助我们对代码进行格式化,我们应该尽量避免有语法问题的写法。

比如注释 ...

option = {
  series: [
    {
      type: 'bar'
      // ...
    }
  ]
};

实时预览和编辑

目前只支持对 Option 代码的预览

\```js live
option = {
  xAxis: {
    data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
  },
  yAxis: {},
  series: [
    {
      type: 'bar',
      data: [23, 24, 18, 25, 27, 28, 25]
    }
  ]
};
\```
option = {
  xAxis: {
    data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
  },
  yAxis: {},
  series: [
    {
      type: 'bar',
      data: [23, 24, 18, 25, 27, 28, 25]
    }
  ]
};
live

更多预览布局

左右

\```js live {layout: 'lr'}
option = {
  ...
};
\```
option = {
  xAxis: {
    data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
  },
  yAxis: {},
  series: [
    {
      type: 'bar',
      data: [23, 24, 18, 25, 27, 28, 25]
    }
  ]
};
live

右左

\```js live {layout: 'rl'}
option = {
  ...
};
\```
option = {
  xAxis: {
    data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
  },
  yAxis: {},
  series: [
    {
      type: 'bar',
      data: [23, 24, 18, 25, 27, 28, 25]
    }
  ]
};
live

下上

\```js live {layout: 'bt'}
option = {
  ...
};
\```
option = {
  xAxis: {
    data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
  },
  yAxis: {},
  series: [
    {
      type: 'bar',
      data: [23, 24, 18, 25, 27, 28, 25]
    }
  ]
};
live

高亮代码行

使用:

\```js {1,3-5}
option = {
  series: [
    {
      type: 'bar',
      data: [23, 24, 18, 25, 27, 28, 25]
    }
  ]
};
\```

效果:

option = {
  series: [
    {
      type: 'bar',
      data: [23, 24, 18, 25, 27, 28, 25]
    }
  ]
};

引用图片

图片实际存放地址在 static/images/ 下。

![图片说明](images/demo.png)

设置图片高宽

对于当前页面的临时样式,可以直接写 html:

<img data-src="images/demo.png" style="width: 50px" />

添加示例 iframe

srchttps://echarts.apache.org/examples/zh/editor.html?c=line-simple 地址中?c=后面这一串

使用:

<md-example src="doc-example/getting-started" width="100%" height="300" />

效果:

添加配置项链接

使用:

<md-option link="series-bar.itemStyle.color" />

效果: series-bar.itemStyle.color

更多组件使用

文档支持使用全局注册的markdown组件,除了刚才介绍的md-example组件,还有下面几种组件

md-alert

提示组件

<md-alert type="info">
This is an info alert.
</md-alert>

This is an info alert.

<md-alert type="success">
This is a success alert.
</md-alert>

This is a success alert.

<md-alert type="warning">
This is a warning alert.
</md-alert>

This is a warning alert.

<md-alert type="warning">
This is a danger alert.
</md-alert>

This is a danger alert.

本文贡献者 在 GitHub 上编辑本页