New GitHub Pages website
#752
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
The current tsParticles 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
Some interactive samples from that collection
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
matteobruni
/
tsparticles
tsParticles - Easily create highly customizable JavaScript particles effects, confetti explosions and fireworks animations and use them as animated backgrounds for your website. Ready to use components available for React.js, Vue.js (2.x and 3.x), Angular, Svelte, jQuery, Preact, Inferno, Solid, Riot and Web Components.
tsParticles - TypeScript Particles
A lightweight TypeScript library for creating particles. Dependency free (*), browser ready and compatible with React.js, Vue.js (2.x and 3.x), Angular, Svelte, jQuery, Preact, Inferno, Riot.js, Solid.js, and Web Components
Table of Contents
-
tsParticles - TypeScript Particles
- Table of Contents
- Do you want to use it on your website?
- Library installation
- Official components for some of the most used frameworks
- Presets
- Templates and Resources
- Demo / Generator
- Video Tutorials
- …
Top comments (0)