- Notifications
You must be signed in to change notification settings - Fork38
Update docs with style/image edits#432
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
5 commits Select commitHold shift + click to select a range
073d495
Added images and changed layout colour
jordanliud752e67
Added new illustrations and adjusted logo
jordanliu1eb0e1f
Added image sizes
jordanliuc6fbc12
readme: formatting
jordanliu017e177
Merge pull request #431 from jordanliu/feature/images
ShMcKFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
102 changes: 81 additions & 21 deletionsdocs/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,93 @@ | ||
<p align="center"> | ||
<a href="https://coderoad.github.io/"> | ||
<img alt="CodeRoad Logo" src="https://user-images.githubusercontent.com/9423525/89562564-26b4f780-d7e8-11ea-9eb0-3109b0e55d3b.png" width="100" /> | ||
</a> | ||
</p> | ||
<h1 align="center"> | ||
CodeRoad VSCode | ||
</h1> | ||
<p align="center"> | ||
<a href="#" alt="Version"><img src="https://vsmarketplacebadge.apphb.com/version/Coderoad.coderoad.svg" /></a> | ||
<a href="#" alt="Installs"><img src="https://vsmarketplacebadge.apphb.com/installs/Coderoad.coderoad.svg" /></a> | ||
<a href="#" alt="Downloads"><img src="https://vsmarketplacebadge.apphb.com/downloads/Coderoad.coderoad.svg" /></a> | ||
</p> | ||
CodeRoad is a VSCode extension that allows you to play interactive coding tutorials in your editor. | ||
 | ||
## Why | ||
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. | ||
For learners, there are a number of advantagestorunning tutorials inside VSCode: | ||
- 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 | ||
## Getting Started | ||
### Start | ||
To start the extension, inside VSCode: | ||
- 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" | ||
### 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) |
2 changes: 1 addition & 1 deletiondocs/docusaurus.config.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletiondocs/src/css/custom.css
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
6 changes: 3 additions & 3 deletionsdocs/src/pages/index.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Binary file modifieddocs/static/img/favicon.ico
Binary file not shown.
Binary file addeddocs/static/img/logo-128.png
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/static/img/logo-16.png
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/static/img/logo-200.png
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/static/img/logo-24.png
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file addeddocs/static/img/logo-32.png
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 39 additions & 1 deletiondocs/static/img/logo.svg
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletionsdocs/static/img/undraw_code.svg
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.