Contributing - Website

So, you'd like to contribute to the impress.js website?

Do you want to contribute to the impress.js website by writing more documentation, improving existing documentation or by adding more pages, fixing some or by doing some better styling? Then let's show you how!

You should start by cloning the impress.js repository. How to do that is explained here. The impress.js website is located in the website/ directory. You may find the website build script in the website/docs/src directory together with the template which you should always use when creating new pages.

Whenever you add a new page to the impress.js docs, you need first add a new navigation entry in the build-script and then run it to regenerate the navigation menu:

                        
npm i
npm run build-website
                        
                    

Adding a new plugin to impress.js

Whenever you add a plugin to impress.js, please also provide a README.md file. Then run the build script as described above. The script will go through the plugins directory and automatically generate the HTML files from the README's

Ideas for what to do

• Translate into other languages
• Guess plugin title from title of READMEs instead of filename
• Optimize dark mode recognition