From 8d84bc8562356f39649502c5b04dbff15763f1b0 Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Sat, 14 Mar 2020 05:00:19 +0000 Subject: [PATCH 1/6] [gitpod-setup] expose port: 3000 and onOpen: open-preview. --- .gitpod.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitpod.yml b/.gitpod.yml index 1f68bc2f..9e654f75 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,3 +1,6 @@ tasks: - init: npm install && npm run build command: npm run dev +ports: + - port: 3000 + onOpen: open-preview From d3ec14f06fc49b97141bb2225229e5a9ce63fa09 Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Sat, 14 Mar 2020 05:01:23 +0000 Subject: [PATCH 2/6] [gitpod-setup] add VS Code extension for stylus support. --- .gitpod.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitpod.yml b/.gitpod.yml index 9e654f75..06d7b5f8 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -4,3 +4,6 @@ tasks: ports: - port: 3000 onOpen: open-preview +vscode: + extensions: + - sysoev.language-stylus@1.11.0:xX39oruAJ5UQzTNVRdbBaQ== \ No newline at end of file From b1acfe458c685b11ddb38c9f7fd605a1d58e695d Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Sat, 14 Mar 2020 05:06:45 +0000 Subject: [PATCH 3/6] add gitpod Ready to Code badge in the Readme. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 46c29971..42c2feb0 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ npm donate gitter + Gitpod Ready-to-Code

Gold Sponsor via Open Collective

From 643850907c6655d8aa6c33a978f3aae9d2f0c509 Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Sat, 14 Mar 2020 05:11:43 +0000 Subject: [PATCH 4/6] update Gitpod description in the Readme. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 42c2feb0..bcf6791f 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,15 @@ Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase) | [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right | | [docpress](https://github.com/docpress/docpress) | Documentation website generator | -## Contributing +## Online one-click setup for Contributing + +You can use Gitpod(A free online VS Code-like IDE) for contributing. With single click it'll launch a workspace and automatically: + +- clone the docsify repo. +- install the dependencies. +- start `npm run dev`. + +So that you can start straight away. [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/docsifyjs/docsify) From 378f151478bfddd115ad98164c8af3ae7fdd8215 Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Sat, 14 Mar 2020 05:13:21 +0000 Subject: [PATCH 5/6] [gitpod-setup] remove the build command to make the server startup faster. --- .gitpod.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitpod.yml b/.gitpod.yml index 06d7b5f8..1eadf623 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,5 +1,5 @@ tasks: - - init: npm install && npm run build + - init: npm install command: npm run dev ports: - port: 3000 From 0eb9708225154f123875dda5074b62f453b9e757 Mon Sep 17 00:00:00 2001 From: Nisar Hassan Naqvi Date: Sat, 14 Mar 2020 07:31:11 +0000 Subject: [PATCH 6/6] [gitpod-setup] fix the preview opening issue. --- .gitpod.yml | 3 ++- README.md | 4 +++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.gitpod.yml b/.gitpod.yml index 1eadf623..8113b45a 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,9 +1,10 @@ tasks: + - command: gp await-port 3000 && sleep 3 && gp preview $(gp url 3000) - init: npm install command: npm run dev ports: - port: 3000 - onOpen: open-preview + onOpen: ignore vscode: extensions: - sysoev.language-stylus@1.11.0:xX39oruAJ5UQzTNVRdbBaQ== \ No newline at end of file diff --git a/README.md b/README.md index bcf6791f..fdef0a95 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,9 @@ Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase) | [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right | | [docpress](https://github.com/docpress/docpress) | Documentation website generator | -## Online one-click setup for Contributing +## Contributing + +### Online one-click setup for Contributing You can use Gitpod(A free online VS Code-like IDE) for contributing. With single click it'll launch a workspace and automatically: