You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 12, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -84,7 +84,8 @@ Netlify Dev will attempt to detect the SSG or build command that you are using,
84
84
**Overriding the detectors**: The number of [project types which Netlify Dev can detect](https://github.com/netlify/netlify-dev-plugin/tree/master/src/detectors) is growing, but if yours is not yet supported (contributions welcome!), you can instruct Netlify Dev to run the project on your behalf by declaring it in a `[dev]` block of your `netlify.toml` file.
85
85
86
86
```toml
87
-
#sample dev block in the toml
87
+
# sample dev block in the toml
88
+
# note: each of these fields are OPTIONAL and should only be used if you need an override
88
89
[dev]
89
90
command = "yarn start" # Command to start your dev server
90
91
port = 3000 # Port that the dev server will be listening on
@@ -226,16 +227,15 @@ After you have installed an add-on, it will be visible with the `netlify addons:
226
227
227
228
For now, it is important to include instructions to create addons for each member of your team, as there is no way to specify addons inside of `netlify.toml`. We are working on this.
228
229
229
-
230
230
## Contributing/Local Development
231
231
232
232
Thanks for contributing! You'll need to follow these steps to run Netlify CLI and `netlify-dev-plugin` locally:
233
233
234
234
0. uninstall any globally installed versions of `netlify-cli`
235
-
1. clone and install deps for https://github.com/netlify/cli
236
-
2. `npm link` from inside the `cli` folder
237
-
3. clone and install deps for this repo
238
-
4. inside the `netlify-dev-plugin` folder, run `yarn link`
239
-
5. inside the `cli` folder, run `yarn link "netlify-dev-plugin"`
235
+
1. clone and install deps for https://github.com/netlify/cli
236
+
1. `npm link` from inside the `cli` folder
237
+
1. clone and install deps for this repo
238
+
1. inside the `netlify-dev-plugin` folder, run `yarn link`
239
+
1. inside the `cli` folder, run `yarn link "netlify-dev-plugin"`
240
240
241
241
Now you're both ready to start testing `netlify dev` and to contribute to the project! Note these are untested instructions, please get in touch if you're unable to follow them clearly and we'll work with you. Or ping [@swyx](https://twitter.com/swyx).
0 commit comments