generated from netlify/build-plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7ebd126
commit 6903e9e
Showing
24 changed files
with
1,855 additions
and
3,639 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -58,7 +58,7 @@ further defined and clarified by project maintainers. | |
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at {{email}}. | ||
reported by contacting the project team at [email protected]. | ||
|
||
All complaints will be reviewed and investigated and will result in a response | ||
that is deemed necessary and appropriate to the circumstances. The project team | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,81 +1,9 @@ | ||
[](https://app.netlify.com/sites/build-plugin-template/deploys) | ||
Netlify Build plugin gatsby - Run Gatsby seamlessly on Netlify. | ||
|
||
Template repository to create new Netlify Build plugins. | ||
# Install | ||
|
||
The main Build plugins documentation can be found | ||
[here](https://docs.netlify.com/configure-builds/build-plugins/). | ||
Please install this plugin from the Netlify app. | ||
|
||
# Initialization | ||
# Configuration | ||
|
||
To create a repository with a new Netlify Build plugin, click on the | ||
["Use this template" button](https://github.com/netlify/build-plugin-template/generate) | ||
on top of the page. | ||
|
||
The repository name should start with `netlify-plugin-`, for example | ||
`netlify-plugin-gatsby`. | ||
|
||
[Clone the repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) | ||
locally. | ||
|
||
Inside the new repository directory, run the following command. | ||
|
||
``` | ||
npm run init | ||
``` | ||
|
||
Some questions will be asked. Make sure the plugin's name matches the repository | ||
name. | ||
|
||
Among other things, this will replace this `README.md` with the plugin's user | ||
documentation. Development documentation will still be available in the | ||
[`CONTRIBUTING.md`](/CONTRIBUTING.md#development-tasks). | ||
|
||
Finally, create a Netlify Site with the repository. This will automatically run | ||
your Build plugins in Netlify Build on every `git push`, as a smoke test. | ||
|
||
You can also add a | ||
[Netlify status badge](https://docs.netlify.com/monitor-sites/status-badges/). | ||
|
||
# Usage | ||
|
||
The plugin's logic should be added to [`./src/index.js`](/src/index.js). | ||
Comments in that file will guide you through the creation of a Build plugin. | ||
|
||
## Development tasks | ||
|
||
The following development tasks are available. Please check the | ||
[`package.json`](/package.json) `scripts` property for more information. | ||
|
||
```bash | ||
npm run build | ||
``` | ||
|
||
Runs a Netlify Build locally with the current plugin. This can be used for | ||
debugging and manual tests. | ||
|
||
The local Build configuration file is [`netlify.toml`](/netlify.toml) and can be | ||
modified. | ||
|
||
```bash | ||
npm run ava | ||
``` | ||
|
||
Runs [unit tests](/test/index.js). | ||
|
||
```bash | ||
npm run lint | ||
``` | ||
|
||
Lints and prettifies source files. | ||
|
||
```bash | ||
npm test | ||
``` | ||
|
||
Runs both unit tests and linting. | ||
|
||
```bash | ||
npm run release | ||
``` | ||
|
||
Publishes this plugin to `npm`. | ||
The following `inputs` options are available. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.