Tsparticles: New GitHub Pages website

Created on 28 Aug 2020  路  5Comments  路  Source: matteobruni/tsparticles

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

documentation enhancement feature_request good first issue help wanted pinned up-for-grabs

Most helpful comment

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

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

All 5 comments

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

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

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

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.

Thanks I forgot to update them, it鈥檚 missing the Samples folder.

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

Was this page helpful?
0 / 5 - 0 ratings

Related issues

matteobruni picture matteobruni  路  6Comments

BenAOlson picture BenAOlson  路  3Comments

matteobruni picture matteobruni  路  4Comments

microraptor picture microraptor  路  3Comments

matteobruni picture matteobruni  路  5Comments