Skip to content

Commit 6baeeb3

Browse files
authored
Merge branch 'main' into feat/libraries-directory
2 parents 95684df + eccabb7 commit 6baeeb3

File tree

998 files changed

+34684
-12627
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

998 files changed

+34684
-12627
lines changed
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: "🐛 Found a Bug"
2+
description: Report p5.js website bugs (broken or incorrect behaviour).
3+
labels: [ Bug ]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
- Please make sure to [search for existing issues](https://github.com/processing/p5.js-website/issues) before filing a new one!
9+
10+
- type: dropdown
11+
attributes:
12+
label: Most appropriate sections of the p5.js website?
13+
options:
14+
- Home
15+
- Reference
16+
- Tutorials
17+
- Examples
18+
- Contribute
19+
- Community (Sketches, Libraries, Events)
20+
- About
21+
- Other (specify if possible)
22+
validations:
23+
required: true
24+
25+
- type: dropdown
26+
attributes:
27+
label: What is your operating system?
28+
options:
29+
- Windows
30+
- Mac OS
31+
- Linux
32+
- Android
33+
- iOS
34+
- Other (specify if possible)
35+
validations:
36+
required: false
37+
38+
- type: input
39+
attributes:
40+
label: Web browser and version
41+
description: |
42+
In the address bar, on Chrome enter `chrome://version`, on Firefox enter `about:support`. On Safari, use `About Safari`.
43+
validations:
44+
required: false
45+
46+
- type: textarea
47+
attributes:
48+
label: Actual Behavior
49+
placeholder: What is currently happening.
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
attributes:
55+
label: Expected Behavior
56+
description: |
57+
If you want to include screenshots, paste them into the markdown editor below.
58+
placeholder: What were you expecting?
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
attributes:
64+
label: Steps to reproduce
65+
description: |
66+
- Add steps to reproduce bugs or add information on the place where the feature should be implemented.
67+
- Add links to a sample deployment or code.
68+
validations:
69+
required: false
70+
71+
- type: input
72+
attributes:
73+
label: Would you like to work on the issue?
74+
description: |
75+
Please let us know if you can work on it or the issue should be assigned to someone else.
76+
validations:
77+
required: true
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: 🌱 New Feature Request
2+
description: Request a new feature be added.
3+
labels: [ Feature Request ]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Increasing Access
8+
description: How would this new feature help [increase access](https://github.com/processing/p5.js/blob/main/contributor_docs/access.md) to p5.js? (If you're not sure, you can type "Unsure" here and let others from the community offer their thoughts.)
9+
validations:
10+
required: true
11+
12+
- type: dropdown
13+
attributes:
14+
label: Most appropriate sub-area of p5.js?
15+
options:
16+
- Home
17+
- Reference
18+
- Tutorials
19+
- Examples
20+
- Contribute
21+
- Community (Sketches, Libraries, Events)
22+
- About
23+
- Other (specify if possible)
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
attributes:
29+
label: Feature request details
30+
validations:
31+
required: true
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: 💭 Discussion
2+
description: This template is for starting a discussion.
3+
labels: [ Discussion ]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Topic
8+
description: What do you want to discuss with the group?
9+
validations:
10+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
blank_issues_enabled: true
2+
3+
contact_links:
4+
- name: 🌸 p5.js Library Issues
5+
url: https://github.com/processing/p5.js/issues
6+
about: Report issues with the p5.js here.
7+
- name: 🖥️ Web Editor Issues
8+
url: https://github.com/processing/p5.js-web-editor/issues
9+
about: Report issues with the p5.js web editor here.
10+
- name: 💬 Forum
11+
url: https://discourse.processing.org/c/p5js
12+
about: Have other questions about using p5.js? Ask them here!

.github/ISSUE_TEMPLATE/default--select-this-.md

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

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,8 @@ pnpm-debug.log*
2222

2323
temp/*
2424
in/
25-
out/
25+
out/
26+
translator/
27+
28+
# Don't commit custom dev builds
29+
public/p5.min.js

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2015-present p5.js contributors & The Processing Foundation
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ If you discover a bug or have an idea for a new feature you'd like to add, begin
99
If you are here to edit or translate content, please do so inside [the `src/content/` folder](/src/content).
1010

1111
### Code Changes
12-
For making code changes, please check out the [technical overview](./docs/techical_overview.md) to get started.
12+
For making code changes, please check out the [technical overview](./docs/technical_overview.md) to get started.
1313

1414
### Adding Libraries
1515
Follow the steps in the <a href="./docs/contributing_libraries.md">Contributing Libraries</a> doc if you would like to add your libary to the collection!

astro.config.mjs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ if (shouldSkipCompress) {
1717

1818
// https://astro.build/config
1919
export default defineConfig({
20+
site: 'https://p5js.org',
2021
integrations: [
2122
preact({
2223
compat: true,
@@ -50,7 +51,7 @@ export default defineConfig({
5051
defaultStrategy: "viewport",
5152
prefetchAll: true,
5253
},
53-
trailingSlash: "ignore",
54+
trailingSlash: "always",
5455
build: {
5556
format: "directory",
5657
},

docs/scripts.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,23 @@ This repo includes a few scripts to pull content from external sources, primaril
44

55
They are all runnable via npm scripts.
66

7+
## Testing the docs of your fork
8+
9+
If you are contributing a change to the main p5.js repo that affects documentation, you will want to preview how your changes will look on the website. To do so, make sure you have committed your changes to a branch of your fork of p5.js.
10+
11+
Then, in the p5.js-website repo, run the following command, using the URL of your fork of p5 before the `#`, and the name of your branch after the `#`:
12+
13+
```sh
14+
npm run custom:dev https://github.com/yourUsername/p5.js.git#yourBranch
15+
```
16+
17+
This will build the reference from your branch and start a development preview of the website. A URL will be logged in the console that you can go to in your browser to test out your changes.
18+
19+
When you're done, you can run this command to reset your changes:
20+
```sh
21+
npm run custom:cleanup
22+
```
23+
724
## After a p5.js release
825

926
To update the content on the p5.js website following a new release of p5.js, you should run all of these commands to pull in the latest content. **Be sure to run the search indices script last as it depends on the results of the other scripts to be accurate.**

0 commit comments

Comments
 (0)