Skip to content

Commit 7f38291

Browse files
feat: add Gitpod config for Docusaurus 2 (facebook#2201)
* feat: fully automates dev setup with gitpod. * Update .gitpod.yml * Update README.md Co-authored-by: Yangshun Tay <[email protected]>
1 parent e4eb919 commit 7f38291

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

.gitpod.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
tasks:
2+
- init: yarn install
3+
command: yarn start
4+
ports:
5+
- port: 3000
6+
onOpen: open-preview

README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
<a href="https://discord.gg/docusaurus"><img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat"></a>
1313
<a href="https://github.com/prettier/prettier"><img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg"></a>
1414
<a href="https://github.com/facebook/jest"><img src="https://img.shields.io/badge/tested_with-jest-99424f.svg" alt="Tested with Jest"></a>
15+
<a href="https://gitpod.io/#https://github.com/facebook/docusaurus"><img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod" alt="Gitpod Ready-to-Code"/></a>
1516
<a href="https://app.netlify.com/sites/docusaurus-preview/deploys"><img src="https://api.netlify.com/api/v1/badges/57ebb454-c937-4c1d-a228-d9dccb494f49/deploy-status" alt="Netlify Status"></a>
1617
</p>
1718

@@ -37,11 +38,17 @@ We've released Docusaurus because it helps us better scale and supports the many
3738

3839
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](https://code.fb.com/codeofconduct) so that you can understand what actions will and will not be tolerated.
3940

40-
### Contributing Guide
41+
### Contributing guide
4142

4243
Read our [contributing guide](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus.
4344

44-
### Beginner Friendly Bugs
45+
### Contribute online with a single click
46+
47+
You can use Gitpod (a free, online, VS Code-based IDE) for contributing. It will launch a ready to code workspace (for Docusaurus 2) with all the dependencies installed and the development server running so that you can start contributing straight away.
48+
49+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/facebook/docusaurus)
50+
51+
### Beginner-friendly bugs
4552

4653
To help you get your feet wet and get you familiar with our contribution process, we have a list of [beginner friendly bugs](https://github.com/facebook/docusaurus/labels/good%20first%20issue) that might contain smaller issues to tackle first. This is a great place to get started.
4754

0 commit comments

Comments
 (0)