3847b3ea.a2216126.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[9],{147:function(e,t,r){"use strict";r.r(t),r.d(t,"frontMatter",(function(){return i})),r.d(t,"metadata",(function(){return c})),r.d(t,"rightToc",(function(){return l})),r.d(t,"default",(function(){return u}));var n=r(2),a=r(9),o=(r(0),r(163)),i={id:"setup",title:"Setup",sidebar_label:"Setup"},c={id:"setup",title:"Setup",description:"### Requirements",source:"@site/docs/setup.md",permalink:"/docs/setup",editUrl:"https://github.com/coderoad/coderoad-vscode/edit/master/docs/docs/setup.md",sidebar_label:"Setup",sidebar:"someSidebar",previous:{title:"Overview",permalink:"/docs/overview"},next:{title:"How CodeRoad Works",permalink:"/docs/how-coderoad-works"}},l=[{value:"Requirements",id:"requirements",children:[]},{value:"Install",id:"install",children:[]},{value:"Start",id:"start",children:[]}],p={rightToc:l};function u(e){var t=e.components,r=Object(a.a)(e,["components"]);return Object(o.b)("wrapper",Object(n.a)({},p,r,{components:t,mdxType:"MDXLayout"}),Object(o.b)("h3",{id:"requirements"},"Requirements"),Object(o.b)("ul",null,Object(o.b)("li",{parentName:"ul"},"OS: MacOS, Windows, Linux"),Object(o.b)("li",{parentName:"ul"},"VSCode 1.39.2+"),Object(o.b)("li",{parentName:"ul"},"Git")),Object(o.b)("h3",{id:"install"},"Install"),Object(o.b)("p",null,"Install CodeRoad from ",Object(o.b)("a",Object(n.a)({parentName:"p"},{href:"https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad"}),"this link in the VSCode Marketplace"),"."),Object(o.b)("p",null,"Once installed, reload the window (",Object(o.b)("inlineCode",{parentName:"p"},"ctrl/cmd + R"),") to get started."),Object(o.b)("h3",{id:"start"},"Start"),Object(o.b)("p",null,Object(o.b)("img",Object(n.a)({parentName:"p"},{src:"/gif/coderoad-example.gif",alt:"CodeRoad Example"}))),Object(o.b)("p",null,"To start the extension, inside VSCode:"),Object(o.b)("ul",null,Object(o.b)("li",{parentName:"ul"},"Open an ",Object(o.b)("strong",{parentName:"li"},"empty")," VSCode workspace (a project folder)"),Object(o.b)("li",{parentName:"ul"},"Launch the app from the VSCode command palette. How?",Object(o.b)("ul",{parentName:"li"},Object(o.b)("li",{parentName:"ul"},"select \u201cView\u201d > \u201cCommand Palette\u201d from the top panel OR press ",Object(o.b)("inlineCode",{parentName:"li"},"cmd/ctrl + shift + P")),Object(o.b)("li",{parentName:"ul"},"in the command palette popup, search for and run ",Object(o.b)("inlineCode",{parentName:"li"},"CodeRoad:Start"))))))}u.isMDXComponent=!0},163:function(e,t,r){"use strict";r.d(t,"a",(function(){return d})),r.d(t,"b",(function(){return m}));var n=r(0),a=r.n(n);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function c(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?i(Object(r),!0).forEach((function(t){o(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):i(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function l(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},o=Object.keys(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=a.a.createContext({}),u=function(e){var t=a.a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):c({},t,{},e)),r},d=function(e){var t=u(e.components);return a.a.createElement(p.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},b=Object(n.forwardRef)((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),d=u(r),b=n,m=d["".concat(i,".").concat(b)]||d[b]||s[b]||o;return r?a.a.createElement(m,c({ref:t},p,{components:r})):a.a.createElement(m,c({ref:t},p))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=b;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c.mdxType="string"==typeof e?e:n,i[1]=c;for(var p=2;p<o;p++)i[p]=r[p];return a.a.createElement.apply(null,i)}return a.a.createElement.apply(null,r)}b.displayName="MDXCreateElement"}}]);