|
1 | | -<palign="center"> |
2 | | - <ahref="https://coderoad.github.io/"> |
3 | | -<img alt="CodeRoad Logo" src="https://user-images.githubusercontent.com/9423525/89562564-26b4f780-d7e8-11ea-9eb0-3109b0e55d3b.png" width="100" /> |
4 | | - </a> |
5 | | -</p> |
6 | | -<h1align="center"> |
7 | | -CodeRoad VSCode |
8 | | -</h1> |
| 1 | +#Website |
9 | 2 |
|
10 | | -<palign="center"> |
11 | | - <ahref="#"alt="Version"><imgsrc="https://vsmarketplacebadge.apphb.com/version/Coderoad.coderoad.svg" /></a> |
12 | | - <ahref="#"alt="Installs"><imgsrc="https://vsmarketplacebadge.apphb.com/installs/Coderoad.coderoad.svg" /></a> |
13 | | - <ahref="#"alt="Downloads"><imgsrc="https://vsmarketplacebadge.apphb.com/downloads/Coderoad.coderoad.svg" /></a> |
14 | | -</p> |
| 3 | +This website is built using[Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. |
15 | 4 |
|
16 | | -CodeRoad is a VSCode extension that allows you to play interactive coding tutorials in your editor. |
| 5 | +###Installation |
17 | 6 |
|
18 | | - |
| 7 | +``` |
| 8 | +$ yarn |
| 9 | +``` |
19 | 10 |
|
20 | | -##Why |
| 11 | +###Local Development |
21 | 12 |
|
22 | | -Interactive learning is the most effective way to gain new skills and knowledge. CodeRoad aims to help tutorial creators develop and share interactive content with the community. |
| 13 | +``` |
| 14 | +$ yarn start |
| 15 | +``` |
23 | 16 |
|
24 | | -For learners, there are a number of advantages to running tutorials inside VSCode: |
| 17 | +This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. |
25 | 18 |
|
26 | | -- learn in a real world coding environment |
27 | | -- get rapid feedback on save and helpful error messages |
28 | | -- users own the code, and can build a Git timeline and deploy a portfolio |
| 19 | +###Build |
29 | 20 |
|
30 | | -##Getting Started |
| 21 | +``` |
| 22 | +$ yarn build |
| 23 | +``` |
31 | 24 |
|
32 | | -###Start |
| 25 | +This command generates static content into the`build` directory and can be served using any static contents hosting service. |
33 | 26 |
|
34 | | -To start the extension, inside VSCode: |
| 27 | +###Deployment |
35 | 28 |
|
36 | | -- open an empty VSCode workspace (an empty folder) |
37 | | -- launch the app from the VSCode command palette: |
38 | | -- select “View” > “Command Palette” from the top panel OR press`cmd/ctrl + shift + P` |
39 | | -- in the command palette, search for and run`CodeRoad:Start` |
40 | | -- a webview should appear on the right side of your editor. Click "Start" |
| 29 | +``` |
| 30 | +$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy |
| 31 | +``` |
41 | 32 |
|
42 | | -###Install |
43 | | - |
44 | | -Install CodeRoad from[this link in the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad). |
45 | | - |
46 | | -- You may need to reload the window (`ctrl/cmd + R`) |
47 | | -- See["Start"](#start) to get started. |
48 | | - |
49 | | -###Requirements |
50 | | - |
51 | | -- OS: MacOS, Windows, Linux |
52 | | -- VSCode 1.39.2+ |
53 | | -- Node.js 10+ |
54 | | -- Git |
55 | | - |
56 | | -##How CodeRoad Works |
57 | | - |
58 | | -Read more in the docs about[how CodeRoad works](https://coderoad.github.io/docs/how-coderoad-works). |
59 | | - |
60 | | -##Creating Tutorials |
61 | | - |
62 | | -Build and share your own interactive tutorials. |
63 | | - |
64 | | -Learn more about[how tutorials area created](https://coderoad.github.io/docs/build-tutorial). |
65 | | - |
66 | | -##Editing Tutorials |
67 | | - |
68 | | -Tutorials can be edited directly as markdown on Github. |
69 | | - |
70 | | -##Development |
71 | | - |
72 | | -To run the extension locally: |
73 | | - |
74 | | -- copy environmental variables from`/web-app/.env.example` as`/web-app/.env` |
75 | | -- install dependencies with`yarn install-all` |
76 | | -- build the extension with`yarn build` |
77 | | -- open the extension with the vscode extension debugger by pressing F5. In the new window, open CodeRoad. |
78 | | - |
79 | | -To test a packaged build locally: |
80 | | - |
81 | | -- if on Mac, ensure you have[VSCode command line tools](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line) installed |
82 | | -- run`yarn package`. It will build the extension and install it locally. |
83 | | -- open a new vscode window and launch the new version of CodeRoad |
84 | | - |
85 | | -##Contributing |
86 | | - |
87 | | -CodeRoad is an ambitious project, we're always looking for contributors :) |
88 | | - |
89 | | -See[CONTRIBUTING.md](./CONTRIBUTING.md). |
90 | | - |
91 | | -##License |
92 | | - |
93 | | -[AGPL v3](./LICENSE.md) |
| 33 | +If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the`gh-pages` branch. |