Giter VIP home page Giter VIP logo

echarts-handbook's Introduction

About

This project is part of the source of The Apache ECharts Official Website. See echarts-website for more details of the building process.

Init

npm install

Dev

npm run dev

Open in browser: http://localhost:3000/echarts-handbook/dist/

Release

# Update contributors
npm run prepare

# Generate to `dist`
npm run generate

Writing

Create a new article

Add .md files under contents/zh/ or contents/en/, and fill in the info in contents/zh/posts.js and contents/en/posts.js.

Reference to Apache ECharts Doc

Do it like this:

xxxx [series.encode](${optionPath}#series.encode) xxxx

Note: if you want it to work in development environment, you may need to edit the config file configs/config.dev.js: make the value of optionPath point to a running environment of echarts-doc.

Reference to an example

Suppose area-basic is one of the example names in echarts-examples.

Just add a link of the example:

[this case](${exampleEditorPath}area-basic&edit=1&reset=1)

Embed the live example into the page:

<iframe width="600" height="300" src="${exampleViewPath}area-basic&edit=1&reset=1"></iframe>

Note: if you want it to work in development environment, you may need to edit the config file configs/config.dev.js: make the value of exampleViewPath and exampleEditorPath point to a running environment of echarts-examples.

echarts-handbook's People

Contributors

100pah avatar hansz00 avatar ovilia avatar pissang avatar plainheart avatar wdingding avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.