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

New GitHub Pages website #752

Closed
matteobruni opened this issue Aug 28, 2020 · 5 comments · Fixed by #775
Closed

New GitHub Pages website #752

matteobruni opened this issue Aug 28, 2020 · 5 comments · Fixed by #775
Labels
documentation Improvements or additions to documentation enhancement New feature or request feature_request good first issue Good for newcomers help wanted Extra attention is needed pinned Pinned issues up-for-grabs

Comments

@matteobruni
Copy link
Collaborator

matteobruni commented Aug 28, 2020

The current Github Page is just the readme, but creating a cool website with samples and guides would be awesome.
The documentation created by TypeDoc inside the core\main folder could be included too.

The website architecture could be done with everything, I don't care about it. Angular, React, Vue.js, plain HTML is all good, the only requirement is it must work fine, and obviously tsParticles must be used to create particles effects.

If ideas are needed you can check out the CodePen collection actively updated with tsParticles configurations: http://codepen.io/collection/DPOage

The website will be hosted at https://particles.js.org (as you can see it's really bad), this is the documentation created by TypeDoc https://particles.js.org/core/main/docs/ but it has issues with Jekill because filenames start with the underscore.

The website will be created inside the new website branch and deployed to gh-pages branch with the build output files.
The branch gh-pages has no .gitignore for docs/ folder, while others have, this behavior must be kept.

The branches tree should be:

website
`- master
   `- gh-pages

If this tree can lead to problems we can discuss about it

@issue-label-bot
Copy link

Issue-Label Bot is automatically applying the label feature_request to this issue, with a confidence of 0.78. Please mark this comment with 👍 or 👎 to give our bot feedback!

Links: app homepage, dashboard and code for this bot.

@matteobruni matteobruni added this to To do in Low Priority via automation Aug 28, 2020
@matteobruni matteobruni added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed pinned Pinned issues up-for-grabs labels Aug 28, 2020
@matteobruni matteobruni linked a pull request Aug 29, 2020 that will close this issue
@matteobruni matteobruni moved this from To do to In progress in Low Priority Aug 29, 2020
@matteobruni matteobruni pinned this issue Aug 31, 2020
@matteobruni
Copy link
Collaborator Author

I've updated the TypeDoc scripts to solve the #773 issue in the #775 PR, it deploys to the gh-pages branch the TypeDoc generated files, probably the simplest way is to customize the theme instead of a new website

@matteobruni matteobruni linked a pull request Aug 31, 2020 that will close this issue
@matteobruni
Copy link
Collaborator Author

The TypeDoc theme used is this: https://github.com/tsparticles/typedoc-particles-theme

@Waterstraal
Copy link

Just a heads up: The demo's listed in the README are not working. For example https://particles.matteobruni.it/#polygonMask does not show a Polygon Mask example.

@matteobruni
Copy link
Collaborator Author

Thanks I forgot to update them, it’s missing the Samples folder.

Those links should be https://particles.matteobruni.it/Samples/#polygonMask

Low Priority automation moved this from In progress to Done Sep 21, 2020
@matteobruni matteobruni unpinned this issue Sep 22, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request feature_request good first issue Good for newcomers help wanted Extra attention is needed pinned Pinned issues up-for-grabs
Projects
No open projects
Low Priority
  
Done
Development

Successfully merging a pull request may close this issue.

2 participants