diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 000000000..05099d186 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,4 @@ +image: gitpod/workspace-full + +tasks: + - init: bundle install \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 48d45207c..a361e05eb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,19 @@ # Developer notes +## Gitpod +This repository supports contribution using [gitpod](https://gitpod.io) which is online IDE using [Theia](https://github.com/eclipse-theia/theia). + +To open-up the environment simple natigate on https://gitpod.io/#https://github.com/rstacruz/cheatsheets + +Or using a button:
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/rstacruz/cheatsheets) + +### Preview built website +To preview the website you need to first build it then you can navigate to file that you are trying to contribute and preview directly. + + + + ## Starting a local instance This starts Jekyll and Webpack. This requires recent versions of [Node.js], [Yarn], [Ruby] and [Bundler] installed. diff --git a/README.md b/README.md index 1380dbee1..c0b0f90f7 100644 --- a/README.md +++ b/README.md @@ -17,3 +17,5 @@ --- See [CONTRIBUTING.md](CONTRIBUTING.md) for developer notes. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/rstacruz/cheatsheets) diff --git a/_docs/images/gitpod_preview_tut.png b/_docs/images/gitpod_preview_tut.png new file mode 100644 index 000000000..e285e1655 Binary files /dev/null and b/_docs/images/gitpod_preview_tut.png differ