Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add script to preview a custom branch #605

Merged
merged 6 commits into from
Nov 2, 2024
Merged

Add script to preview a custom branch #605

merged 6 commits into from
Nov 2, 2024

Conversation

davepagurek
Copy link
Collaborator

@davepagurek davepagurek commented Oct 17, 2024

This adds a script, npm run custom:dev https://github.com/yourUsername/p5.js.git#yourBranch, that builds the reference off of your fork of p5 and starts a dev server (and also npm run custom:cleanup to remove the reference changes afterwards.)

It also makes the reference schema a little more forgiving, making more things optional with fallbacks, as these builds are less likely to be entirely complete.

@davepagurek davepagurek marked this pull request as draft October 17, 2024 21:14
@davepagurek davepagurek changed the title WIP: build docs from 2.0 dev branches Add script to preview a custom branch Nov 2, 2024
@davepagurek davepagurek marked this pull request as ready for review November 2, 2024 00:07
@davepagurek
Copy link
Collaborator Author

@limzykenneth This changes how the p5 reference is built, now just npm installing and calling npm run docs directly. This is maybe a little slower for 1.x when we could just run yuidoc directly, but it means it builds the docs correctly for both 1.x and 2.x.

I'm hoping this will make it easier for contributors to be able to preview their docs changes.

@davepagurek davepagurek merged commit b8408d4 into main Nov 2, 2024
4 checks passed
@davepagurek davepagurek deleted the dev-2.0-docs branch November 2, 2024 00:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant