c9874733.48945dc8.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[17],{121:function(e,t,a){"use strict";a.r(t),a.d(t,"frontMatter",(function(){return i})),a.d(t,"metadata",(function(){return r})),a.d(t,"rightToc",(function(){return c})),a.d(t,"default",(function(){return s}));var n=a(1),b=a(6),l=(a(0),a(136)),i={id:"style",title:"Style Guide",sidebar_label:"Style Guide"},r={id:"style",title:"Style Guide",description:"You can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).\r",source:"@site/docs\\style.md",permalink:"/api-4p/docs/style",editUrl:"https://github.com/Danon/api-4p/edit/master/docs/style.md",sidebar_label:"Style Guide",sidebar:"someSidebar",next:{title:"Acquire authorization token",permalink:"/api-4p/docs/login"}},c=[{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:c};function s(e){var t=e.components,a=Object(b.a)(e,["components"]);return Object(l.b)("wrapper",Object(n.a)({},o,a,{components:t,mdxType:"MDXLayout"}),Object(l.b)("p",null,"You can write content using ",Object(l.b)("a",Object(n.a)({parentName:"p"},{href:"https://github.github.com/gfm/"}),"GitHub-flavored Markdown syntax"),"."),Object(l.b)("h2",{id:"headers"},"Headers"),Object(l.b)("h1",{id:"h1---create-the-best-documentation"},"H1 - Create the best documentation"),Object(l.b)("h2",{id:"h2---create-the-best-documentation"},"H2 - Create the best documentation"),Object(l.b)("h3",{id:"h3---create-the-best-documentation"},"H3 - Create the best documentation"),Object(l.b)("h4",{id:"h4---create-the-best-documentation"},"H4 - Create the best documentation"),Object(l.b)("h5",{id:"h5---create-the-best-documentation"},"H5 - Create the best documentation"),Object(l.b)("h6",{id:"h6---create-the-best-documentation"},"H6 - Create the best documentation"),Object(l.b)("hr",null),Object(l.b)("h2",{id:"emphasis"},"Emphasis"),Object(l.b)("p",null,"Emphasis, aka italics, with ",Object(l.b)("em",{parentName:"p"},"asterisks")," or ",Object(l.b)("em",{parentName:"p"},"underscores"),"."),Object(l.b)("p",null,"Strong emphasis, aka bold, with ",Object(l.b)("strong",{parentName:"p"},"asterisks")," or ",Object(l.b)("strong",{parentName:"p"},"underscores"),"."),Object(l.b)("p",null,"Combined emphasis with ",Object(l.b)("strong",{parentName:"p"},"asterisks and ",Object(l.b)("em",{parentName:"strong"},"underscores")),"."),Object(l.b)("p",null,"Strikethrough uses two tildes. ",Object(l.b)("del",{parentName:"p"},"Scratch this.")),Object(l.b)("hr",null),Object(l.b)("h2",{id:"lists"},"Lists"),Object(l.b)("ol",null,Object(l.b)("li",{parentName:"ol"},"First ordered list item"),Object(l.b)("li",{parentName:"ol"},"Another item \u22c5\u22c5","*"," Unordered sub-list."),Object(l.b)("li",{parentName:"ol"},"Actual numbers don't matter, just that it's a number \u22c5\u22c51. Ordered sub-list"),Object(l.b)("li",{parentName:"ol"},"And another item.")),Object(l.b)("p",null,"\u22c5\u22c5\u22c5You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown)."),Object(l.b)("p",null,"\u22c5\u22c5\u22c5To have a line break without a paragraph, you will need to use two trailing spaces.\u22c5\u22c5 \u22c5\u22c5\u22c5Note that this line is separate, but within the same paragraph.\u22c5\u22c5 \u22c5\u22c5\u22c5(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)"),Object(l.b)("ul",null,Object(l.b)("li",{parentName:"ul"},"Unordered list can use asterisks")),Object(l.b)("ul",null,Object(l.b)("li",{parentName:"ul"},"Or minuses")),Object(l.b)("ul",null,Object(l.b)("li",{parentName:"ul"},"Or pluses")),Object(l.b)("hr",null),Object(l.b)("h2",{id:"links"},"Links"),Object(l.b)("p",null,Object(l.b)("a",Object(n.a)({parentName:"p"},{href:"https://www.google.com"}),"I'm an inline-style link")),Object(l.b)("p",null,Object(l.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(l.b)("p",null,Object(l.b)("a",Object(n.a)({parentName:"p"},{href:"https://www.mozilla.org"}),"I'm a reference-style link")),Object(l.b)("p",null,Object(l.b)("a",Object(n.a)({parentName:"p"},{href:"../blob/master/LICENSE"}),"I'm a relative reference to a repository file")),Object(l.b)("p",null,Object(l.b)("a",Object(n.a)({parentName:"p"},{href:"http://slashdot.org"}),"You can use numbers for reference-style link definitions")),Object(l.b)("p",null,"Or leave it empty and use the ",Object(l.b)("a",Object(n.a)({parentName:"p"},{href:"http://www.reddit.com"}),"link text itself"),"."),Object(l.b)("p",null,"URLs and URLs in angle brackets will automatically get turned into links. ",Object(l.b)("a",Object(n.a)({parentName:"p"},{href:"http://www.example.com"}),"http://www.example.com")," or ",Object(l.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(l.b)("p",null,"Some text to show that the reference links can follow later."),Object(l.b)("hr",null),Object(l.b)("h2",{id:"images"},"Images"),Object(l.b)("p",null,"Here's our logo (hover to see the title text):"),Object(l.b)("p",null,"Inline-style: ",Object(l.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(l.b)("p",null,"Reference-style: ",Object(l.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(l.b)("hr",null),Object(l.b)("h2",{id:"code"},"Code"),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-javascript"}),"var s = 'JavaScript syntax highlighting';\nalert(s);\n")),Object(l.b)("pre",null,Object(l.b)("code",Object(n.a)({parentName:"pre"},{className:"language-python"}),'s = "Python syntax highlighting"\nprint(s)\n')),Object(l.b)("pre",null,Object(l.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(l.b)("hr",null),Object(l.b)("h2",{id:"tables"},"Tables"),Object(l.b)("p",null,"Colons can be used to align columns."),Object(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Tables"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:"center"}),"Are"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:"right"}),"Cool"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"col 3 is"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"right-aligned"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:"right"}),"\\$1600")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"col 2 is"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"centered"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:"right"}),"\\$12")),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"zebra stripes"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:"center"}),"are neat"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:"right"}),"\\$1")))),Object(l.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(l.b)("table",null,Object(l.b)("thead",{parentName:"table"},Object(l.b)("tr",{parentName:"thead"},Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Markdown"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Less"),Object(l.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Pretty"))),Object(l.b)("tbody",{parentName:"table"},Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("em",{parentName:"td"},"Still")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("inlineCode",{parentName:"td"},"renders")),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(l.b)("strong",{parentName:"td"},"nicely"))),Object(l.b)("tr",{parentName:"tbody"},Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"1"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"2"),Object(l.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"3")))),Object(l.b)("hr",null),Object(l.b)("h2",{id:"blockquotes"},"Blockquotes"),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.")),Object(l.b)("p",null,"Quote break."),Object(l.b)("blockquote",null,Object(l.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(l.b)("em",{parentName:"p"},"put")," ",Object(l.b)("strong",{parentName:"p"},"Markdown")," into a blockquote.")),Object(l.b)("hr",null),Object(l.b)("h2",{id:"inline-html"},"Inline HTML"),Object(l.b)("dl",null,Object(l.b)("dt",null,"Definition list"),Object(l.b)("dd",null,"Is something people use sometimes."),Object(l.b)("dt",null,"Markdown in HTML"),Object(l.b)("dd",null,"Does *not* work **very** well. Use HTML ",Object(l.b)("em",null,"tags"),".")),Object(l.b)("hr",null),Object(l.b)("h2",{id:"line-breaks"},"Line Breaks"),Object(l.b)("p",null,"Here's a line for us to start with."),Object(l.b)("p",null,"This line is separated from the one above by two newlines, so it will be a ",Object(l.b)("em",{parentName:"p"},"separate paragraph"),"."),Object(l.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(l.b)("em",{parentName:"p"},"same paragraph"),"."),Object(l.b)("hr",null),Object(l.b)("h2",{id:"admonitions"},"Admonitions"),Object(l.b)("div",{className:"admonition admonition-important alert alert--info"},Object(l.b)("div",Object(n.a)({parentName:"div"},{className:"admonition-heading"}),Object(l.b)("h5",{parentName:"div"},Object(l.b)("span",Object(n.a)({parentName:"h5"},{className:"admonition-icon"}),Object(l.b)("svg",Object(n.a)({parentName:"span"},{xmlns:"http://www.w3.org/2000/svg",width:"14",height:"16",viewBox:"0 0 14 16"}),Object(l.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"})))),"This is important :::")),Object(l.b)("div",Object(n.a)({parentName:"div"},{className:"admonition-content"}))),Object(l.b)("div",{className:"admonition admonition-warning alert alert--danger"},Object(l.b)("div",Object(n.a)({parentName:"div"},{className:"admonition-heading"}),Object(l.b)("h5",{parentName:"div"},Object(l.b)("span",Object(n.a)({parentName:"h5"},{className:"admonition-icon"}),Object(l.b)("svg",Object(n.a)({parentName:"span"},{xmlns:"http://www.w3.org/2000/svg",width:"12",height:"16",viewBox:"0 0 12 16"}),Object(l.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"})))),"This is a warning :::")),Object(l.b)("div",Object(n.a)({parentName:"div"},{className:"admonition-content"}))))}s.isMDXComponent=!0}}]);