-This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
+
+
+
+
+
-### Installation
+CodeRoad is a VSCode extension that allows you to play interactive coding tutorials in your editor.
-```
-$ yarn
-```
+
-### Local Development
+## Why
-```
-$ yarn start
-```
+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.
-This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
+For learners, there are a number of advantages to running tutorials inside VSCode:
-### Build
+- learn in a real world coding environment
+- get rapid feedback on save and helpful error messages
+- users own the code, and can build a Git timeline and deploy a portfolio
-```
-$ yarn build
-```
+## Getting Started
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+### Start
-### Deployment
+To start the extension, inside VSCode:
-```
-$ GIT_USER= USE_SSH=true yarn deploy
-```
+- open an empty VSCode workspace (an empty folder)
+- launch the app from the VSCode command palette:
+ - select “View” > “Command Palette” from the top panel OR press `cmd/ctrl + shift + P`
+ - in the command palette, search for and run `CodeRoad:Start`
+- a webview should appear on the right side of your editor. Click "Start"
-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.
+### Install
+
+Install CodeRoad from [this link in the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad).
+
+- You may need to reload the window (`ctrl/cmd + R`)
+- See ["Start"](#start) to get started.
+
+### Requirements
+
+- OS: MacOS, Windows, Linux
+- VSCode 1.39.2+
+- Node.js 10+
+- Git
+
+## How CodeRoad Works
+
+Read more in the docs about [how CodeRoad works](https://coderoad.github.io/docs/how-coderoad-works).
+
+## Creating Tutorials
+
+Build and share your own interactive tutorials.
+
+Learn more about [how tutorials area created](https://coderoad.github.io/docs/build-tutorial).
+
+## Editing Tutorials
+
+Tutorials can be edited directly as markdown on Github.
+
+## Development
+
+To run the extension locally:
+
+- copy environmental variables from `/web-app/.env.example` as `/web-app/.env`
+- install dependencies with `yarn install-all`
+- build the extension with `yarn build`
+- open the extension with the vscode extension debugger by pressing F5. In the new window, open CodeRoad.
+
+To test a packaged build locally:
+
+- if on Mac, ensure you have [VSCode command line tools](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line) installed
+- run `yarn package`. It will build the extension and install it locally.
+- open a new vscode window and launch the new version of CodeRoad
+
+## Contributing
+
+CodeRoad is an ambitious project, we're always looking for contributors :)
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+## License
+
+[AGPL v3](./LICENSE.md)
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
index 91faffbb..a865de64 100644
--- a/docs/docusaurus.config.js
+++ b/docs/docusaurus.config.js
@@ -15,7 +15,7 @@ module.exports = {
navbar: {
title: 'CodeRoad',
logo: {
- alt: 'My Site Logo',
+ alt: 'CodeRoad Logo',
src: 'img/logo.svg',
},
links: [
diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css
index 74ba0f27..3111c9bc 100644
--- a/docs/src/css/custom.css
+++ b/docs/src/css/custom.css
@@ -7,7 +7,7 @@
/* You can override the default Infima variables here. */
:root {
- --ifm-color-primary: #25c2a0;
+ --ifm-color-primary: #33a5f1;
--ifm-color-primary-dark: rgb(33, 175, 144);
--ifm-color-primary-darker: rgb(31, 165, 136);
--ifm-color-primary-darkest: rgb(26, 136, 112);
diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js
index e692e8b0..2bf4b52a 100644
--- a/docs/src/pages/index.js
+++ b/docs/src/pages/index.js
@@ -9,17 +9,17 @@ import styles from './styles.module.css'
const features = [
{
title: <>Your Editor,
- imageUrl: 'img/undraw_docusaurus_mountain.svg',
+ imageUrl: 'img/undraw_editor.svg',
description: <>Playing tutorials in a real-world setting: within your coding editor.,
},
{
title: <>Your Code,
- imageUrl: 'img/undraw_docusaurus_tree.svg',
+ imageUrl: 'img/undraw_code.svg',
description: <>You own your progress. Save with Git to build your timeline. Deploy to build your portfolio.,
},
{
title: <>Free & Open,
- imageUrl: 'img/undraw_docusaurus_react.svg',
+ imageUrl: 'img/undraw_open_source.svg',
description: <>CodeRoad is open-source. Build your own tutorials. Contribute to the tooling.,
},
]
diff --git a/docs/static/img/favicon.ico b/docs/static/img/favicon.ico
index be74abd6..9bd224ab 100644
Binary files a/docs/static/img/favicon.ico and b/docs/static/img/favicon.ico differ
diff --git a/docs/static/img/logo-128.png b/docs/static/img/logo-128.png
new file mode 100644
index 00000000..d0d5bf15
Binary files /dev/null and b/docs/static/img/logo-128.png differ
diff --git a/docs/static/img/logo-16.png b/docs/static/img/logo-16.png
new file mode 100644
index 00000000..2d1ebab0
Binary files /dev/null and b/docs/static/img/logo-16.png differ
diff --git a/docs/static/img/logo-200.png b/docs/static/img/logo-200.png
new file mode 100644
index 00000000..2a0a7b99
Binary files /dev/null and b/docs/static/img/logo-200.png differ
diff --git a/docs/static/img/logo-24.png b/docs/static/img/logo-24.png
new file mode 100644
index 00000000..861a7ff1
Binary files /dev/null and b/docs/static/img/logo-24.png differ
diff --git a/docs/static/img/logo-32.png b/docs/static/img/logo-32.png
new file mode 100644
index 00000000..9bd224ab
Binary files /dev/null and b/docs/static/img/logo-32.png differ
diff --git a/docs/static/img/logo.svg b/docs/static/img/logo.svg
index 9db6d0d0..ca3ce987 100644
--- a/docs/static/img/logo.svg
+++ b/docs/static/img/logo.svg
@@ -1 +1,39 @@
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/static/img/undraw_code.svg b/docs/static/img/undraw_code.svg
new file mode 100644
index 00000000..83d69229
--- /dev/null
+++ b/docs/static/img/undraw_code.svg
@@ -0,0 +1,21 @@
+
diff --git a/docs/static/img/undraw_docusaurus_mountain.svg b/docs/static/img/undraw_docusaurus_mountain.svg
deleted file mode 100644
index 431cef2f..00000000
--- a/docs/static/img/undraw_docusaurus_mountain.svg
+++ /dev/null
@@ -1,170 +0,0 @@
-
diff --git a/docs/static/img/undraw_docusaurus_react.svg b/docs/static/img/undraw_docusaurus_react.svg
deleted file mode 100644
index e4170504..00000000
--- a/docs/static/img/undraw_docusaurus_react.svg
+++ /dev/null
@@ -1,169 +0,0 @@
-
diff --git a/docs/static/img/undraw_docusaurus_tree.svg b/docs/static/img/undraw_docusaurus_tree.svg
deleted file mode 100644
index a05cc03d..00000000
--- a/docs/static/img/undraw_docusaurus_tree.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/docs/static/img/undraw_editor.svg b/docs/static/img/undraw_editor.svg
new file mode 100644
index 00000000..312a2559
--- /dev/null
+++ b/docs/static/img/undraw_editor.svg
@@ -0,0 +1,54 @@
+
diff --git a/docs/static/img/undraw_open_source.svg b/docs/static/img/undraw_open_source.svg
new file mode 100644
index 00000000..4e425bda
--- /dev/null
+++ b/docs/static/img/undraw_open_source.svg
@@ -0,0 +1,32 @@
+
+
+
+ 
+ 
+