Create a website for the library

[mahozad]

In addition to #4, generate documentations, examples, etc. on a website using GitHub Pages.

The initial version of the website has been created in the website branch of the repository.

• Rename the github-pages branch to website (remember to update the repository pages settings as well if the branch name was changed).

• Remember to regularly rebase the site git branch onto the main branch to keep it updated

• Add a link to the library javadoc in site: https://www.javadoc.io/doc/ir.mahozad.android/pie-chart/latest/index.html

• Add website link and icon in https://mahozad.ir

• Add project changelog to the site (could automate it with workflows?)

• Customize the scrollbar indicator of the website

• Add dark/light switch toggle (can use my own component): see this YouTube video and this post

• Specify size for the images and use placeholders like this for images. See this YouTube video

To show colored code in the site, create a gist in GitHub for that snippet of code and use its embed link in the site (customizing the gist).
We can also use online syntax highlighters such as this or this.

Testing the website performance: https://developers.google.com/speed/pagespeed/insights/

Add a header to site and add the following CSS property to it which results in something like header of this site (See this Stack Overflow post):

header {
  backdrop-filter: blur(4px);
}

Remember that dokka can produce a jekyll format as well.

• https://github.com/peaceiris/actions-gh-pages

Static site generators:

• mkdocs (used by dokka website)
• Material for Web
• Orchid
• mdbook
• GitBook
• Zola
• docsify
• Assemble
• docpress
• jinja (used by Kotlin website)
• https://github.com/collections/static-site-generators
• https://github.com/facebook/docusaurus

Websites and templates to inspire from:
https://google.github.io/accompanist/insets/
https://developer.chrome.com/tags/devtools-engineering/
https://www.kernel.org/
https://probot.github.io/docs/
https://docs.botui.org/
https://cssgradient.io/
https://fossheim.io/writing/posts/css-text-gradient/
https://doks.netlify.app/docs/prologue/commands/
https://geekdocs.de/
https://themes.gohugo.io/themes/hugo-changelog-theme/
https://github.com/pmarsceill/just-the-docs
https://github.com/collections/github-pages-examples
https://sighingnow.github.io/jekyll-gitbook
https://supunkavinda.github.io/jekyll-theme-leaf/
https://pmarsceill.github.io/just-the-docs/docs/configuration/
http://alexander.heimbu.ch/millidocs/
https://orderedlist.com/minimal/
https://docs.docker.com/
https://www.vectary.com/
https://github.com/wikimedia/wikimedia.github.io
https://kit.svelte.dev/

candidate page background color: #faf7f4 (adopted from this site)