@@ -87,12 +87,12 @@ add (**sandbox** vs. **container**).
8787
8888To get started, you should first follow the steps in our contribution guidelines
8989in order to
90- [ set up CodeSandbox locally] ( https://github.com/codesandbox/codesandbox-client/blob/master /CONTRIBUTING.md#setting-up-the-project-locally ) .
90+ [ set up CodeSandbox locally] ( https://github.com/codesandbox/codesandbox-client/blob/main /CONTRIBUTING.md#setting-up-the-project-locally ) .
9191
9292### 1. Add template logo
9393
9494Add the logo for your template in the
95- [ templates repo] ( https://github.com/codesandbox/codesandbox-client/tree/master /packages/template-icons/src )
95+ [ templates repo] ( https://github.com/codesandbox/codesandbox-client/tree/main /packages/template-icons/src )
9696(` codesandbox-templates/packages/template-icons/src ` ).
9797
9898#### SVG logos
@@ -102,24 +102,24 @@ content. If your template's name is "Banana", name your logo file "BananaIcon".
102102
103103Examples:
104104
105- - [ Vue logo] ( https://github.com/codesandbox/codesandbox-client/tree/master /packages/template-icons/src/VueIcon.tsx )
106- - [ React logo] ( https://github.com/codesandbox/codesandbox-client/tree/master /packages/template-icons/src/ReactIcon.tsx )
105+ - [ Vue logo] ( https://github.com/codesandbox/codesandbox-client/tree/main /packages/template-icons/src/VueIcon.tsx )
106+ - [ React logo] ( https://github.com/codesandbox/codesandbox-client/tree/main /packages/template-icons/src/ReactIcon.tsx )
107107
108108### 2. Add template definition
109109
110110In order for CodeSandbox to recognise your template, you need to add a new
111111definition of it in the ` codesandbox-client/packages/common/src/templates `
112- [ directory] ( https://github.com/codesandbox/codesandbox-client/tree/master /packages/common/src/templates ) .
112+ [ directory] ( https://github.com/codesandbox/codesandbox-client/tree/main /packages/common/src/templates ) .
113113You do this by creating a new ` .ts ` file with the name of your template.
114114
115115Examples:
116116
117- - [ Parcel] ( https://github.com/codesandbox/codesandbox-client/blob/master /packages/common/src/templates/parcel.ts )
118- - [ Gatsby] ( https://github.com/codesandbox/codesandbox-client/blob/master /packages/common/src/templates/gatsby.ts )
117+ - [ Parcel] ( https://github.com/codesandbox/codesandbox-client/blob/main /packages/common/src/templates/parcel.ts )
118+ - [ Gatsby] ( https://github.com/codesandbox/codesandbox-client/blob/main /packages/common/src/templates/gatsby.ts )
119119
120120The template definition can have various options, which you can find more
121121information about in
122- [ template.ts] ( https://github.com/codesandbox/codesandbox-client/blob/master /packages/common/src/templates/template.ts ) .
122+ [ template.ts] ( https://github.com/codesandbox/codesandbox-client/blob/main /packages/common/src/templates/template.ts ) .
123123
124124We encourage you to improve the user experience of your templates by taking
125125advantage of the options you have available while writing your template
@@ -133,7 +133,7 @@ Examples:
133133<!-- TODO: Add more examples -->
134134
135135After writing your template definition, you also need to add it to the
136- [ index.js] ( https://github.com/codesandbox/codesandbox-client/blob/master /packages/common/src/templates/index.ts )
136+ [ index.js] ( https://github.com/codesandbox/codesandbox-client/blob/main /packages/common/src/templates/index.ts )
137137file in the same directory (` codesandbox-client/packages/common/src/templates ` )
138138in order for CodeSandbox to be able to retrieve your template.
139139
@@ -148,18 +148,18 @@ preset.
148148
149149We call a template configuration for the bundler in CodeSandbox a 'Preset'. All
150150currently installed presets are defined in the
151- [ index.ts] ( https://github.com/codesandbox/codesandbox-client/blob/master /packages/app/src/sandbox/eval/index.ts )
151+ [ index.ts] ( https://github.com/codesandbox/codesandbox-client/blob/main /packages/app/src/sandbox/eval/index.ts )
152152file under ` codesandbox-client/packages/app/src/sandbox/eval/presets ` .
153153
154154In order to understand how this configuration works, we recommend you to take a
155155look at templates that have already been implemented and their presets.
156156
157157Examples:
158158
159- - [ create-react-app-typescript] ( https://github.com/codesandbox/codesandbox-client/blob/master /packages/app/src/sandbox/eval/presets/create-react-app-typescript/index.js )
159+ - [ create-react-app-typescript] ( https://github.com/codesandbox/codesandbox-client/blob/main /packages/app/src/sandbox/eval/presets/create-react-app-typescript/index.js )
160160 (most basic one)
161- - [ CxJS] ( https://github.com/codesandbox/codesandbox-client/blob/master /packages/app/src/sandbox/eval/presets/cxjs/index.js )
162- - [ vue-cli] ( https://github.com/codesandbox/codesandbox-client/blob/master /packages/app/src/sandbox/eval/presets/vue-cli/index.js )
161+ - [ CxJS] ( https://github.com/codesandbox/codesandbox-client/blob/main /packages/app/src/sandbox/eval/presets/cxjs/index.js )
162+ - [ vue-cli] ( https://github.com/codesandbox/codesandbox-client/blob/main /packages/app/src/sandbox/eval/presets/vue-cli/index.js )
163163
164164### 4. Add the importer
165165
@@ -169,7 +169,7 @@ template for every template. This logic is **not** found in `codesanbox-client`.
169169
170170This means you that you also have to add your template in another file in the
171171` codesandbox-importers ` repository called
172- [ templates.ts] ( https://github.com/codesandbox/codesandbox-importers/blob/master /packages/import-utils/src/create-sandbox/templates.ts ) .
172+ [ templates.ts] ( https://github.com/codesandbox/codesandbox-importers/blob/main /packages/import-utils/src/create-sandbox/templates.ts ) .
173173
174174When you create your Pull Request in ` codesanbox-client ` , you also need to
175175create a Pull Request in ` codesandbox-importer ` and reference it in your Pull
@@ -190,7 +190,7 @@ functionality of templates using containers.
190190
191191To test your new template, you need to create a mock response from the API and
192192force the new template specification. To do this, you uncomment
193- [ this line] ( https://github.com/codesandbox/codesandbox-client/blob/master /packages/app/src/app/store/actions.js#L17 )
193+ [ this line] ( https://github.com/codesandbox/codesandbox-client/blob/main /packages/app/src/app/store/actions.js#L17 )
194194and change ` 'custom' ` to the id/name of your template:
195195
196196``` diff
0 commit comments