c4796d88.1a22965d.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[17],{117:function(e,t,a){"use strict";a.r(t),a.d(t,"frontMatter",(function(){return c})),a.d(t,"metadata",(function(){return l})),a.d(t,"rightToc",(function(){return r})),a.d(t,"default",(function(){return s}));var n=a(2),b=a(6),i=(a(0),a(130)),c={id:"doc-style",title:"Style Guide",sidebar_label:"Style Guide"},l={id:"doc-style",title:"Style Guide",description:"You can write content using GitHub-flavored Markdown syntax.",source:"@site/docs/doc-style.md",permalink:"/docs/doc-style",editUrl:"https://github.com/flink-lab/home-page/edit/master/docs/doc-style.md",sidebar_label:"Style Guide",sidebar:"someSidebar",previous:{title:"Stream Switch",permalink:"/docs/doc-stream-switch"},next:{title:"Powered by MDX",permalink:"/docs/mdx"}},r=[{value:"Markdown Syntax",id:"markdown-syntax",children:[]},{value:"Headers",id:"headers",children:[]},{value:"H2 - Create the best documentation",id:"h2---create-the-best-documentation",children:[{value:"H3 - Create the best documentation",id:"h3---create-the-best-documentation",children:[]}]},{value:"Emphasis",id:"emphasis",children:[]},{value:"Lists",id:"lists",children:[]},{value:"Links",id:"links",children:[]},{value:"Images",id:"images",children:[]},{value:"Code",id:"code",children:[]},{value:"Tables",id:"tables",children:[]},{value:"Blockquotes",id:"blockquotes",children:[]},{value:"Inline HTML",id:"inline-html",children:[]},{value:"Line Breaks",id:"line-breaks",children:[]},{value:"Admonitions",id:"admonitions",children:[]}],o={rightToc:r};function s(e){var t=e.components,a=Object(b.a)(e,["components"]);return Object(i.b)("wrapper",Object(n.a)({},o,a,{components:t,mdxType:"MDXLayout"}),Object(i.b)("p",null,"You can write content using ",Object(i.b)("a",Object(n.a)({parentName:"p"},{href:"https://github.github.com/gfm/"}),"GitHub-flavored Markdown syntax"),"."),Object(i.b)("h2",{id:"markdown-syntax"},"Markdown Syntax"),Object(i.b)("p",null,"To serve as an example page when styling markdown based Docusaurus sites."),Object(i.b)("h2",{id:"headers"},"Headers"),Object(i.b)("h1",{id:"h1---create-the-best-documentation"},"H1 - Create the best documentation"),Object(i.b)("h2",{id:"h2---create-the-best-documentation"},"H2 - Create the best documentation"),Object(i.b)("h3",{id:"h3---create-the-best-documentation"},"H3 - Create the best documentation"),Object(i.b)("h4",{id:"h4---create-the-best-documentation"},"H4 - Create the best documentation"),Object(i.b)("h5",{id:"h5---create-the-best-documentation"},"H5 - Create the best documentation"),Object(i.b)("h6",{id:"h6---create-the-best-documentation"},"H6 - Create the best documentation"),Object(i.b)("hr",null),Object(i.b)("h2",{id:"emphasis"},"Emphasis"),Object(i.b)("p",null,"Emphasis, aka italics, with ",Object(i.b)("em",{parentName:"p"},"asterisks")," or ",Object(i.b)("em",{parentName:"p"},"underscores"),"."),Object(i.b)("p",null,"Strong emphasis, aka bold, with ",Object(i.b)("strong",{parentName:"p"},"asterisks")," or ",Object(i.b)("strong",{parentName:"p"},"underscores"),"."),Object(i.b)("p",null,"Combined emphasis with ",Object(i.b)("strong",{parentName:"p"},"asterisks and ",Object(i.b)("em",{parentName:"strong"},"underscores")),"."),Object(i.b)("p",null,"Strikethrough uses two tildes. ",Object(i.b)("del",{parentName:"p"},"Scratch this.")),Object(i.b)("hr",null),Object(i.b)("h2",{id:"lists"},"Lists"),Object(i.b)("ol",null,Object(i.b)("li",{parentName:"ol"},"First ordered list item"),Object(i.b)("li",{parentName:"ol"},"Another item",Object(i.b)("ul",{parentName:"li"},Object(i.b)("li",{parentName:"ul"},"Unordered sub-list."))),Object(i.b)("li",{parentName:"ol"},"Actual numbers don't matter, just that it's a number",Object(i.b)("ol",{parentName:"li"},Object(i.b)("li",{parentName:"ol"},"Ordered sub-list"))),Object(i.b)("li",{parentName:"ol"},"And another item.")),Object(i.b)("ul",null,Object(i.b)("li",{parentName:"ul"},"Unordered list can use asterisks")),Object(i.b)("ul",null,Object(i.b)("li",{parentName:"ul"},"Or minuses")),Object(i.b)("ul",null,Object(i.b)("li",{parentName:"ul"},"Or pluses")),Object(i.b)("hr",null),Object(i.b)("h2",{id:"links"},"Links"),Object(i.b)("p",null,Object(i.b)("a",Object(n.a)({parentName:"p"},{href:"https://www.google.com/"}),"I'm an inline-style link")),Object(i.b)("p",null,Object(i.b)("a",Object(n.a)({parentName:"p"},{href:"https://www.google.com/",title:"Google's Homepage"}),"I'm an inline-style link with title")),Object(i.b)("p",null,Object(i.b)("a",Object(n.a)({parentName:"p"},{href:"https://www.mozilla.org/"}),"I'm a reference-style link")),Object(i.b)("p",null,Object(i.b)("a",Object(n.a)({parentName:"p"},{href:"../blob/master/LICENSE"}),"I'm a relative reference to a repository file")),Object(i.b)("p",null,Object(i.b)("a",Object(n.a)({parentName:"p"},{href:"http://slashdot.org/"}),"You can use numbers for reference-style link definitions")),Object(i.b)("p",null,"Or leave it empty and use the ",Object(i.b)("a",Object(n.a)({parentName:"p"},{href:"http://www.reddit.com/"}),"link text itself"),"."),Object(i.b)("p",null,"URLs and URLs in angle brackets will automatically get turned into links. ",Object(i.b)("a",Object(n.a)({parentName:"p"},{href:"http://www.example.com/"}),"http://www.example.com/")," or ",Object(i.b)("a",Object(n.a)({parentName:"p"},{href:"http://www.example.com/"}),"http://www.example.com/")," and sometimes example.com (but not on GitHub, for example)."),Object(i.b)("p",null,"Some text to show that the reference links can follow later."),Object(i.b)("hr",null),Object(i.b)("h2",{id:"images"},"Images"),Object(i.b)("p",null,"Here's our logo (hover to see the title text):"),Object(i.b)("p",null,"Inline-style: ",Object(i.b)("img",Object(n.a)({parentName:"p"},{src:"https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png",alt:"alt text",title:"Logo Title Text 1"}))),Object(i.b)("p",null,"Reference-style: ",Object(i.b)("img",Object(n.a)({parentName:"p"},{src:"https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png",alt:"alt text",title:"Logo Title Text 2"}))),Object(i.b)("hr",null),Object(i.b)("h2",{id:"code"},"Code"),Object(i.b)("pre",null,Object(i.b)("code",Object(n.a)({parentName:"pre"},{className:"language-javascript"}),"var s = 'JavaScript syntax highlighting';\nalert(s);\n")),Object(i.b)("pre",null,Object(i.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),'s = "Python syntax highlighting"\nprint(s)\n')),Object(i.b)("pre",null,Object(i.b)("code",Object(n.a)({parentName:"pre"},{}),"No language indicated, so no syntax highlighting.\nBut let's throw in a <b>tag</b>.\n")),Object(i.b)("pre",null,Object(i.b)("code",Object(n.a)({parentName:"pre"},{className:"language-js",metastring:"{2}","{2}":!0}),"function highlightMe() {\n  console.log('This line can be highlighted!');\n}\n")),Object(i.b)("hr",null),Object(i.b)("h2",{id:"tables"},"Tables"),Object(i.b)("p",null,"Colons can be used to align columns."),Object(i.b)("table",null,Object(i.b)("thead",{parentName:"table"},Object(i.b)("tr",{parentName:"thead"},Object(i.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Tables"),Object(i.b)("th",Object(n.a)({parentName:"tr"},{align:"center"}),"Are"),Object(i.b)("th",Object(n.a)({parentName:"tr"},{align:"right"}),"Cool"))),Object(i.b)("tbody",{parentName:"table"},Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"col 3 is"),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"right-aligned"),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"right"}),"\\$1600")),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"col 2 is"),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"centered"),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"right"}),"\\$12")),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"zebra stripes"),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"are neat"),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:"right"}),"\\$1")))),Object(i.b)("p",null,"There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown."),Object(i.b)("table",null,Object(i.b)("thead",{parentName:"table"},Object(i.b)("tr",{parentName:"thead"},Object(i.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Markdown"),Object(i.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Less"),Object(i.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Pretty"))),Object(i.b)("tbody",{parentName:"table"},Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("em",{parentName:"td"},"Still")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("inlineCode",{parentName:"td"},"renders")),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(i.b)("strong",{parentName:"td"},"nicely"))),Object(i.b)("tr",{parentName:"tbody"},Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"1"),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"2"),Object(i.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"3")))),Object(i.b)("hr",null),Object(i.b)("h2",{id:"blockquotes"},"Blockquotes"),Object(i.b)("blockquote",null,Object(i.b)("p",{parentName:"blockquote"},"Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.")),Object(i.b)("p",null,"Quote break."),Object(i.b)("blockquote",null,Object(i.b)("p",{parentName:"blockquote"},"This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can ",Object(i.b)("em",{parentName:"p"},"put")," ",Object(i.b)("strong",{parentName:"p"},"Markdown")," into a blockquote.")),Object(i.b)("hr",null),Object(i.b)("h2",{id:"inline-html"},"Inline HTML"),Object(i.b)("dl",null,Object(i.b)("dt",null,"Definition list"),Object(i.b)("dd",null,"Is something people use sometimes."),Object(i.b)("dt",null,"Markdown in HTML"),Object(i.b)("dd",null,"Does *not* work **very** well. Use HTML ",Object(i.b)("em",null,"tags"),".")),Object(i.b)("hr",null),Object(i.b)("h2",{id:"line-breaks"},"Line Breaks"),Object(i.b)("p",null,"Here's a line for us to start with."),Object(i.b)("p",null,"This line is separated from the one above by two newlines, so it will be a ",Object(i.b)("em",{parentName:"p"},"separate paragraph"),"."),Object(i.b)("p",null,"This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the ",Object(i.b)("em",{parentName:"p"},"same paragraph"),"."),Object(i.b)("hr",null),Object(i.b)("h2",{id:"admonitions"},"Admonitions"),Object(i.b)("div",{className:"admonition admonition-note alert alert--secondary"},Object(i.b)("div",Object(n.a)({parentName:"div"},{className:"admonition-heading"}),Object(i.b)("h5",{parentName:"div"},Object(i.b)("span",Object(n.a)({parentName:"h5"},{className:"admonition-icon"}),Object(i.b)("svg",Object(n.a)({parentName:"span"},{xmlns:"http://www.w3.org/2000/svg",width:"14",height:"16",viewBox:"0 0 14 16"}),Object(i.b)("path",Object(n.a)({parentName:"svg"},{fillRule:"evenodd",d:"M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"})))),"note")),Object(i.b)("div",Object(n.a)({parentName:"div"},{className:"admonition-content"}),Object(i.b)("p",{parentName:"div"},"This is a note"))),Object(i.b)("div",{className:"admonition admonition-tip alert alert--success"},Object(i.b)("div",Object(n.a)({parentName:"div"},{className:"admonition-heading"}),Object(i.b)("h5",{parentName:"div"},Object(i.b)("span",Object(n.a)({parentName:"h5"},{className:"admonition-icon"}),Object(i.b)("svg",Object(n.a)({parentName:"span"},{xmlns:"http://www.w3.org/2000/svg",width:"12",height:"16",viewBox:"0 0 12 16"}),Object(i.b)("path",Object(n.a)({parentName:"svg"},{fillRule:"evenodd",d:"M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"})))),"tip")),Object(i.b)("div",Object(n.a)({parentName:"div"},{className:"admonition-content"}),Object(i.b)("p",{parentName:"div"},"This is a tip"))),Object(i.b)("div",{className:"admonition admonition-important alert alert--info"},Object(i.b)("div",Object(n.a)({parentName:"div"},{className:"admonition-heading"}),Object(i.b)("h5",{parentName:"div"},Object(i.b)("span",Object(n.a)({parentName:"h5"},{className:"admonition-icon"}),Object(i.b)("svg",Object(n.a)({parentName:"span"},{xmlns:"http://www.w3.org/2000/svg",width:"14",height:"16",viewBox:"0 0 14 16"}),Object(i.b)("path",Object(n.a)({parentName:"svg"},{fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"})))),"important")),Object(i.b)("div",Object(n.a)({parentName:"div"},{className:"admonition-content"}),Object(i.b)("p",{parentName:"div"},"This is important"))),Object(i.b)("div",{className:"admonition admonition-caution alert alert--warning"},Object(i.b)("div",Object(n.a)({parentName:"div"},{className:"admonition-heading"}),Object(i.b)("h5",{parentName:"div"},Object(i.b)("span",Object(n.a)({parentName:"h5"},{className:"admonition-icon"}),Object(i.b)("svg",Object(n.a)({parentName:"span"},{xmlns:"http://www.w3.org/2000/svg",width:"16",height:"16",viewBox:"0 0 16 16"}),Object(i.b)("path",Object(n.a)({parentName:"svg"},{fillRule:"evenodd",d:"M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"})))),"caution")),Object(i.b)("div",Object(n.a)({parentName:"div"},{className:"admonition-content"}),Object(i.b)("p",{parentName:"div"},"This is a caution"))),Object(i.b)("div",{className:"admonition admonition-warning alert alert--danger"},Object(i.b)("div",Object(n.a)({parentName:"div"},{className:"admonition-heading"}),Object(i.b)("h5",{parentName:"div"},Object(i.b)("span",Object(n.a)({parentName:"h5"},{className:"admonition-icon"}),Object(i.b)("svg",Object(n.a)({parentName:"span"},{xmlns:"http://www.w3.org/2000/svg",width:"12",height:"16",viewBox:"0 0 12 16"}),Object(i.b)("path",Object(n.a)({parentName:"svg"},{fillRule:"evenodd",d:"M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"})))),"warning")),Object(i.b)("div",Object(n.a)({parentName:"div"},{className:"admonition-content"}),Object(i.b)("p",{parentName:"div"},"This is a warning"))))}s.isMDXComponent=!0}}]);