blob: 3abcbba3d76579bd9ff2941d2b0a02bb512d0fee [file] [log] [blame]
__NUXT_JSONP__("/en/meta/edit-guide", (function(a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z,A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z,_,$,aa,ab,ac,ad,ae,af,ag,ah,ai,aj,ak){return {data:[{article:{slug:"edit-guide",toc:[{id:A,depth:q,text:B},{id:C,depth:q,text:D},{id:E,depth:q,text:F},{id:G,depth:q,text:H},{id:I,depth:t,text:J},{id:K,depth:t,text:L},{id:M,depth:t,text:N},{id:O,depth:t,text:P},{id:Q,depth:t,text:R},{id:S,depth:q,text:T},{id:U,depth:t,text:V},{id:W,depth:q,text:X},{id:Y,depth:q,text:Z},{id:_,depth:q,text:$},{id:r,depth:t,text:r}],body:{type:"root",children:[{type:b,tag:"h1",props:{id:"document-editing-guidelines"},children:[{type:b,tag:g,props:{href:"#document-editing-guidelines",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:"Document Editing Guidelines"}]},{type:a,value:c},{type:b,tag:s,props:{id:A},children:[{type:b,tag:g,props:{href:"#adding-a-markdown-file",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:B}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"Add a markdown file to the "},{type:b,tag:p,props:{},children:[{type:a,value:"contents\u002Fzh\u002F"}]},{type:a,value:" (Chinese posts) or "},{type:b,tag:p,props:{},children:[{type:a,value:"contents\u002Fen\u002F"}]},{type:a,value:" (English posts) directories, up to three levels. Update the path and title information in "},{type:b,tag:p,props:{},children:[{type:a,value:"contents\u002Fzh\u002Fposts.yml"}]},{type:a,value:" or "},{type:b,tag:p,props:{},children:[{type:a,value:"contents\u002Fen\u002Fposts.yml"}]},{type:a,value:aa}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"Lowercase markdown file names."}]},{type:a,value:c},{type:b,tag:s,props:{id:C},children:[{type:b,tag:g,props:{href:"#using-prettier-to-automatically-format-code",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:D}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"Before you start, we recommend installing the "},{type:b,tag:g,props:{href:"https:\u002F\u002Fmarketplace.visualstudio.com\u002Fitems?itemName=esbenp.prettier-vscode",rel:[ab,ac,ad],target:ae},children:[{type:a,value:"prettier VSCode plugin"}]},{type:a,value:", which will automatically format the code for you when you save it."}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"If you feel that the automatic formatting is breaking your code block, you can add the following comment to prevent "},{type:b,tag:p,props:{},children:[{type:a,value:"prettier"}]},{type:a,value:" from formatting the code inside the block"}]},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"\u003C!-- prettier-ignore-start --\u003E\n\u003C!-- prettier-ignore-end --\u003E\n"}]}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"If you find blocks of code that are not formatted, check first for syntax errors in the code."}]},{type:a,value:c},{type:b,tag:s,props:{id:E},children:[{type:b,tag:g,props:{href:"#built-in-variables",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:F}]},{type:a,value:c},{type:b,tag:"ul",props:{},children:[{type:a,value:c},{type:b,tag:w,props:{},children:[{type:b,tag:p,props:{},children:[{type:a,value:"optionPath"}]}]},{type:a,value:c},{type:b,tag:w,props:{},children:[{type:b,tag:p,props:{},children:[{type:a,value:"mainSitePath"}]}]},{type:a,value:c},{type:b,tag:w,props:{},children:[{type:b,tag:p,props:{},children:[{type:a,value:"exampleViewPath"}]}]},{type:a,value:c},{type:b,tag:w,props:{},children:[{type:b,tag:p,props:{},children:[{type:a,value:"exampleEditorPath"}]}]},{type:a,value:c}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"Usage:"}]},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:"null","line-highlights":d,"file-name":d},children:[{type:a,value:"${xxxxx}\n"}]}]},{type:a,value:c},{type:b,tag:s,props:{id:G},children:[{type:b,tag:g,props:{href:"#embedding-code",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:H}]},{type:a,value:c},{type:b,tag:u,props:{id:I},children:[{type:b,tag:g,props:{href:"#basic-usage",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:J}]},{type:a,value:c},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"```js\noption = {\n series: [{\n type: 'bar',\n data: [23, 24, 18, 25, 27, 28, 25]\n }]\n};\n\\```\n"}]}]},{type:a,value:c},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:v,"line-highlights":d,"file-name":d},children:[{type:a,value:af}]}]},{type:a,value:c},{type:b,tag:u,props:{id:K},children:[{type:b,tag:g,props:{href:"#recommended-way-of-writing-code",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:L}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"In order to allow the tool to help us format the code, we should try to avoid syntactically problematic writing styles."}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"For example, the comment "},{type:b,tag:p,props:{},children:[{type:a,value:"..."}]}]},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:v,"line-highlights":d,"file-name":d},children:[{type:a,value:"option = {\n series: [\n {\n type: 'bar'\n \u002F\u002F ...\n }\n ]\n};\n"}]}]},{type:a,value:c},{type:b,tag:u,props:{id:M},children:[{type:b,tag:g,props:{href:"#live-preview-and-editing",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:N}]},{type:a,value:c},{type:b,tag:"blockquote",props:{},children:[{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"Currently only preview of Option code is supported"}]},{type:a,value:c}]},{type:a,value:c},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"```js [live]\noption = {\n xAxis: {\n data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']\n },\n yAxis: {},\n series: [\n {\n type: 'bar',\n data: [23, 24, 18, 25, 27, 28, 25]\n }\n ]\n};\n\\```\n"}]}]},{type:a,value:c},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:x,props:{lang:v,layout:"tb"},children:[{type:a,value:y}]}]},{type:a,value:c},{type:b,tag:u,props:{id:O},children:[{type:b,tag:g,props:{href:"#more-preview-layouts",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:P}]},{type:a,value:c},{type:b,tag:z,props:{id:"left-to-right"},children:[{type:b,tag:g,props:{href:"#left-to-right",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:"Left to Right"}]},{type:a,value:c},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"```js [live-lr]\noption = {\n ...\n};\n\\```\n"}]}]},{type:a,value:c},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:x,props:{lang:v,layout:"lr"},children:[{type:a,value:y}]}]},{type:a,value:c},{type:b,tag:z,props:{id:"right-to-left"},children:[{type:b,tag:g,props:{href:"#right-to-left",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:"Right to left"}]},{type:a,value:c},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"```js [live-rl]\noption = {\n ...\n};\n\\```\n"}]}]},{type:a,value:c},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:x,props:{lang:v,layout:"rl"},children:[{type:a,value:y}]}]},{type:a,value:c},{type:b,tag:z,props:{id:"down-to-up"},children:[{type:b,tag:g,props:{href:"#down-to-up",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:"Down to Up"}]},{type:a,value:c},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"```js [live-bt]\noption = {\n ...\n};\n\\```\n"}]}]},{type:a,value:c},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:x,props:{lang:v,layout:"bt"},children:[{type:a,value:y}]}]},{type:a,value:c},{type:b,tag:u,props:{id:Q},children:[{type:b,tag:g,props:{href:"#highlighting-lines-of-code-and-adding-filenames",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:R}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"Use."}]},{type:a,value:c},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"```js{1,3-5}[option.js]\noption = {\n series: [\n {\n type: 'bar',\n data: [23, 24, 18, 25, 27, 28, 25]\n }\n ]\n};\n\\```\n"}]}]},{type:a,value:c},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"Effects."}]},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:v,"line-highlights":"1,3-5","file-name":"option.js"},children:[{type:a,value:af}]}]},{type:a,value:c},{type:b,tag:s,props:{id:S},children:[{type:b,tag:g,props:{href:"#embedding-images",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:T}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"Source images are stored under "},{type:b,tag:p,props:{},children:[{type:a,value:"static\u002Fimages\u002F"}]},{type:a,value:aa}]},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"![image description](images\u002Fdemo.png)\n"}]}]},{type:a,value:c},{type:b,tag:u,props:{id:U},children:[{type:b,tag:g,props:{href:"#set-the-image-height-and-width",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:V}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"For the temporary style of the current page, you can just write html."}]},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"\u003Cimg src=\"images\u002Fdemo.png\" style=\"width: 50px\" \u002F\u003E\n"}]}]},{type:a,value:c},{type:b,tag:s,props:{id:W},children:[{type:b,tag:g,props:{href:"#add-example-iframe",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:X}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:b,tag:p,props:{},children:[{type:a,value:"src"}]},{type:a,value:" is the string after "},{type:b,tag:p,props:{},children:[{type:a,value:"?c="}]},{type:a,value:" in the "},{type:b,tag:g,props:{href:ag,rel:[ab,ac,ad],target:ae},children:[{type:a,value:ag}]},{type:a,value:" address"}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:ah}]},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"\u003Cmd-example src=\"doc-example\u002Fgetting-started\" width=\"100%\" height=\"300\"\u003E\u003C\u002Fmd-example\u003E\n"}]}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:ai},{type:b,tag:aj,props:{src:"doc-example\u002Fgetting-started",width:"100%",height:300},children:[]}]},{type:a,value:c},{type:b,tag:s,props:{id:Y},children:[{type:b,tag:g,props:{href:"#add-link-to-option-item",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:Z}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:ah}]},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"\u003Cmd-option link=\"series-bar.itemStyle.color\"\u003E\u003C\u002Fmd-option\u003E\n"}]}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:ai},{type:b,tag:"md-option",props:{link:"series-bar.itemStyle.color"},children:[]}]},{type:a,value:c},{type:b,tag:s,props:{id:_},children:[{type:b,tag:g,props:{href:"#more-component-usage",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:$}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"The documentation supports the use of globally registered "},{type:b,tag:p,props:{},children:[{type:a,value:o}]},{type:a,value:" components. In addition to the "},{type:b,tag:p,props:{},children:[{type:a,value:aj}]},{type:a,value:" component just described, the following components are also available"}]},{type:a,value:c},{type:b,tag:u,props:{id:r},children:[{type:b,tag:g,props:{href:"#md-alert",ariaHidden:i,tabIndex:j},children:[{type:b,tag:k,props:{className:[l,m]},children:[]}]},{type:a,value:r}]},{type:a,value:c},{type:b,tag:h,props:{},children:[{type:a,value:"Prompt components"}]},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"\u003Cmd-alert type=\"info\"\u003E\nThis is an info alert.\n\u003C\u002Fmd-alert\u003E\n"}]}]},{type:a,value:c},{type:b,tag:r,props:{type:"info"},children:[{type:a,value:"\nThis is an info alert.\n"}]},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"\u003Cmd-alert type=\"success\"\u003E\nThis is a success alert.\n\u003C\u002Fmd-alert\u003E\n"}]}]},{type:a,value:c},{type:b,tag:r,props:{type:"success"},children:[{type:a,value:"\nThis is a success alert.\n"}]},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"\u003Cmd-alert type=\"warning\"\u003E\nThis is a warning alert.\n\u003C\u002Fmd-alert\u003E\n"}]}]},{type:a,value:c},{type:b,tag:r,props:{type:"warning"},children:[{type:a,value:"\nThis is a warning alert.\n"}]},{type:a,value:c},{type:b,tag:e,props:{className:[f]},children:[{type:b,tag:n,props:{lang:o,"line-highlights":d,"file-name":d},children:[{type:a,value:"\u003Cmd-alert type=\"warning\"\u003E\nThis is a danger alert.\n\u003C\u002Fmd-alert\u003E\n"}]}]},{type:a,value:c},{type:b,tag:r,props:{type:"danger"},children:[{type:a,value:"\nThis is a danger alert.\n"}]}]},dir:"\u002Fen\u002Fmeta",path:"\u002Fen\u002Fmeta\u002Fedit-guide",extension:".md",createdAt:ak,updatedAt:ak},postPath:"en\u002Fmeta\u002Fedit-guide"}],fetch:{},mutations:[]}}("text","element","\n","","div","nuxt-content-highlight","a","p","true",-1,"span","icon","icon-link","md-code-block","markdown","code",2,"md-alert","h2",3,"h3","js","li","md-live","option = {\n xAxis: {\n data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']\n },\n yAxis: {},\n series: [\n {\n type: 'bar',\n data: [23, 24, 18, 25, 27, 28, 25]\n }\n ]\n};\n","h4","adding-a-markdown-file","Adding a Markdown File","using-prettier-to-automatically-format-code","Using Prettier to Automatically Format Code","built-in-variables","Built-in Variables","embedding-code","Embedding Code","basic-usage","Basic Usage","recommended-way-of-writing-code","Recommended Way of Writing Code","live-preview-and-editing","Live Preview and Editing","more-preview-layouts","More Preview Layouts","highlighting-lines-of-code-and-adding-filenames","Highlighting Lines of Code and Adding Filenames","embedding-images","Embedding Images","set-the-image-height-and-width","Set the Image Height and Width","add-example-iframe","Add Example Iframe","add-link-to-option-item","Add Link to Option Item","more-component-usage","More Component Usage",".","nofollow","noopener","noreferrer","_blank","option = {\n series: [\n {\n type: 'bar',\n data: [23, 24, 18, 25, 27, 28, 25]\n }\n ]\n};\n","https:\u002F\u002Fecharts.apache.org\u002Fexamples\u002Fen\u002Feditor.html?c=line-simple","Use:","Result:\n","md-example","2021-08-02T05:33:02.867Z")));