Skip to content

Commit 6903e9e

Browse files
committed
Init
1 parent 7ebd126 commit 6903e9e

24 files changed

+1855
-3639
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Command line options and/or configuration file, if any.
4242
Enter the following command in a terminal and copy/paste its output:
4343

4444
```bash
45-
npx envinfo --system --binaries --browsers --npmPackages netlify-plugin-{{name}}
45+
npx envinfo --system --binaries --browsers --npmPackages netlify-plugin-gatsby
4646
```
4747

4848
**Screenshots**

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ further defined and clarified by project maintainers.
5858
## Enforcement
5959

6060
Instances of abusive, harassing, or otherwise unacceptable behavior may be
61-
reported by contacting the project team at {{email}}.
61+
reported by contacting the project team at [email protected].
6262

6363
All complaints will be reviewed and investigated and will result in a response
6464
that is deemed necessary and appropriate to the circumstances. The project team

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) {{year}} {{author}}
3+
Copyright (c) 2021 Luke Oliff
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of
66
this software and associated documentation files (the "Software"), to deal in

README.md

Lines changed: 5 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,9 @@
1-
[![Netlify Status](https://api.netlify.com/api/v1/badges/79deda3b-d696-4878-b15d-d9f3a862bdfc/deploy-status)](https://app.netlify.com/sites/build-plugin-template/deploys)
1+
Netlify Build plugin gatsby - Run Gatsby seamlessly on Netlify.
22

3-
Template repository to create new Netlify Build plugins.
3+
# Install
44

5-
The main Build plugins documentation can be found
6-
[here](https://docs.netlify.com/configure-builds/build-plugins/).
5+
Please install this plugin from the Netlify app.
76

8-
# Initialization
7+
# Configuration
98

10-
To create a repository with a new Netlify Build plugin, click on the
11-
["Use this template" button](https://github.com/netlify/build-plugin-template/generate)
12-
on top of the page.
13-
14-
The repository name should start with `netlify-plugin-`, for example
15-
`netlify-plugin-gatsby`.
16-
17-
[Clone the repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
18-
locally.
19-
20-
Inside the new repository directory, run the following command.
21-
22-
```
23-
npm run init
24-
```
25-
26-
Some questions will be asked. Make sure the plugin's name matches the repository
27-
name.
28-
29-
Among other things, this will replace this `README.md` with the plugin's user
30-
documentation. Development documentation will still be available in the
31-
[`CONTRIBUTING.md`](/CONTRIBUTING.md#development-tasks).
32-
33-
Finally, create a Netlify Site with the repository. This will automatically run
34-
your Build plugins in Netlify Build on every `git push`, as a smoke test.
35-
36-
You can also add a
37-
[Netlify status badge](https://docs.netlify.com/monitor-sites/status-badges/).
38-
39-
# Usage
40-
41-
The plugin's logic should be added to [`./src/index.js`](/src/index.js).
42-
Comments in that file will guide you through the creation of a Build plugin.
43-
44-
## Development tasks
45-
46-
The following development tasks are available. Please check the
47-
[`package.json`](/package.json) `scripts` property for more information.
48-
49-
```bash
50-
npm run build
51-
```
52-
53-
Runs a Netlify Build locally with the current plugin. This can be used for
54-
debugging and manual tests.
55-
56-
The local Build configuration file is [`netlify.toml`](/netlify.toml) and can be
57-
modified.
58-
59-
```bash
60-
npm run ava
61-
```
62-
63-
Runs [unit tests](/test/index.js).
64-
65-
```bash
66-
npm run lint
67-
```
68-
69-
Lints and prettifies source files.
70-
71-
```bash
72-
npm test
73-
```
74-
75-
Runs both unit tests and linting.
76-
77-
```bash
78-
npm run release
79-
```
80-
81-
Publishes this plugin to `npm`.
9+
The following `inputs` options are available.

init/README.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

init/bin.js

Lines changed: 0 additions & 66 deletions
This file was deleted.

init/clean.js

Lines changed: 0 additions & 61 deletions
This file was deleted.

init/copy.js

Lines changed: 0 additions & 13 deletions
This file was deleted.

init/main.js

Lines changed: 0 additions & 39 deletions
This file was deleted.

init/options.js

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)