diff --git a/HACKING.md b/HACKING.md index 1bc576cf45f..9e2729b2807 100644 --- a/HACKING.md +++ b/HACKING.md @@ -68,6 +68,29 @@ Other Jekyll commands [are documented](https://jekyllrb.com/docs/usage/) on the - [`robots.txt`](https://en.wikipedia.org/wiki/Robots.txt) is for web scraping robots. - [`humans.txt`](https://endoflife.date/humans.txt) holds details about the people and tech behind the project. +## Extending the Jekyll theme + +The site is based on the [Just the Docs](https://github.com/just-the-docs/just-the-docs) Jekyll theme. Take a look at +[the documentation](https://just-the-docs.github.io/just-the-docs/) for knowing more about its configuration (beware, +this configuration is for the current `main` branch, not for the version used by this site). + +If you need to override some parts, take a look at [the customization section](https://just-the-docs.github.io/just-the-docs/docs/customization/) +of the documentation. + + +## Logo + +The site logo is [Openmoji's _hourglass not done_ icon](https://openmoji.org/). Derived icons for various usages, such +as [the web app manifest](/manifest.json) were also generated from Openmoji's SVG icon using +[RealFaviconGenerator.net](https://realfavicongenerator.net/). + +All icons were placed in the [`assets`](/assets) directory, except [`favicon.ico`](/favicon.ico). The _Just the Docs_ +Jekyll theme mandates its path to `/favicon.ico`, and it seems a lot of browsers +[assume this location anyway](https://stackoverflow.com/a/21359390/374236). + +Note that `android-chrome-*.png` icons were renamed to `logo-*.png`. Those icons are used in other contexts, such as +on the site as a logo. + ## Automation Automation is currently focused towards fetching the latest releases for a given release cycle. Scripts for this are in the `_auto` directory, and run using `Rakefile`. diff --git a/README.md b/README.md index 484418ae249..05ba4f16240 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,24 @@ While participating in the project, you must abide by its [Code of Conduct](CODE ## API An API is available for integration with CI platforms. API documentation is available at https://endoflife.date/docs/api. The API is currently in Alpha, and breaking changes can happen. + ## License Licensed under the [MIT License](LICENSE). +## Credits + +endoflife.date is relying on various amazing software and components : + +- [GitHub](https://github.com/), an Internet hosting service for software development and version control, +- [Jekyll](https://jekyllrb.com/), a static site generator. +- [Ruby](https://jekyllrb.com/), a dynamic and open source programming language with a focus on simplicity and + productivity. +- [Just the Docs](https://github.com/just-the-docs/just-the-docs), a documentation theme for Jekyll. +- [Stoplight Elements](https://stoplight.io/open-source/elements), a collection of UI components for displaying + beautiful developer documentation from any OpenAPI document. +- [Openmoji](https://openmoji.org/), open source emojis for designers, developers and everyone else! +- [Simple Icons](https://simpleicons.org/), free SVG icons for popular brands. +- [Netlify](https://www.netlify.com/), an all-in-one platform for automating modern web projects. + [hacktoberfest]: https://github.com/endoflife-date/endoflife.date/issues/408 diff --git a/_config.yml b/_config.yml index 31ee0174213..e329b5aafc4 100644 --- a/_config.yml +++ b/_config.yml @@ -59,7 +59,7 @@ defaults: - scope: path: "" values: - image: /logo.png + image: /logo-512.png - scope: path: "products" values: diff --git a/_includes/head_custom.html b/_includes/head_custom.html index 12df0142354..6a830370970 100644 --- a/_includes/head_custom.html +++ b/_includes/head_custom.html @@ -7,3 +7,14 @@ {% endcapture %} + + + + + + + + + + + diff --git a/assets/apple-touch-icon.png b/assets/apple-touch-icon.png new file mode 100644 index 00000000000..d2b4d431770 Binary files /dev/null and b/assets/apple-touch-icon.png differ diff --git a/assets/favicon-16x16.png b/assets/favicon-16x16.png new file mode 100644 index 00000000000..3a86ac8698b Binary files /dev/null and b/assets/favicon-16x16.png differ diff --git a/assets/favicon-32x32.png b/assets/favicon-32x32.png new file mode 100644 index 00000000000..9136666efd3 Binary files /dev/null and b/assets/favicon-32x32.png differ diff --git a/assets/favicon.ico b/assets/favicon.ico deleted file mode 100644 index c2b03cf1662..00000000000 Binary files a/assets/favicon.ico and /dev/null differ diff --git a/assets/icon.png b/assets/icon.png deleted file mode 100644 index 383c42d0a00..00000000000 Binary files a/assets/icon.png and /dev/null differ diff --git a/assets/icon.svg b/assets/icon.svg deleted file mode 100644 index 2d93157e815..00000000000 --- a/assets/icon.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/assets/logo-192x192.png b/assets/logo-192x192.png new file mode 100644 index 00000000000..969b6189320 Binary files /dev/null and b/assets/logo-192x192.png differ diff --git a/assets/logo-512x512.png b/assets/logo-512x512.png new file mode 100644 index 00000000000..d701eb9149a Binary files /dev/null and b/assets/logo-512x512.png differ diff --git a/assets/logo.png b/assets/logo.png deleted file mode 100644 index a3c350dfe2b..00000000000 Binary files a/assets/logo.png and /dev/null differ diff --git a/assets/logo.svg b/assets/logo.svg new file mode 100644 index 00000000000..4416618e3e7 --- /dev/null +++ b/assets/logo.svg @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/assets/mstile-144x144.png b/assets/mstile-144x144.png new file mode 100644 index 00000000000..f14842ac050 Binary files /dev/null and b/assets/mstile-144x144.png differ diff --git a/assets/mstile-150x150.png b/assets/mstile-150x150.png new file mode 100644 index 00000000000..5c5a65b8081 Binary files /dev/null and b/assets/mstile-150x150.png differ diff --git a/assets/mstile-310x150.png b/assets/mstile-310x150.png new file mode 100644 index 00000000000..17475e3f429 Binary files /dev/null and b/assets/mstile-310x150.png differ diff --git a/assets/mstile-310x310.png b/assets/mstile-310x310.png new file mode 100644 index 00000000000..9649aa58eb5 Binary files /dev/null and b/assets/mstile-310x310.png differ diff --git a/assets/mstile-70x70.png b/assets/mstile-70x70.png new file mode 100644 index 00000000000..438921fd876 Binary files /dev/null and b/assets/mstile-70x70.png differ diff --git a/assets/safari-pinned-tab.svg b/assets/safari-pinned-tab.svg new file mode 100644 index 00000000000..b85d2747116 --- /dev/null +++ b/assets/safari-pinned-tab.svg @@ -0,0 +1,49 @@ + + + + +Created by potrace 1.14, written by Peter Selinger 2001-2017 + + + + + + diff --git a/browserconfig.xml b/browserconfig.xml new file mode 100644 index 00000000000..abeb4fbe00b --- /dev/null +++ b/browserconfig.xml @@ -0,0 +1,12 @@ +--- +# See https://webmasters.stackexchange.com/q/131077 +--- + + + + + + #da532c + + + diff --git a/favicon.ico b/favicon.ico new file mode 100644 index 00000000000..9c400a68cd2 Binary files /dev/null and b/favicon.ico differ diff --git a/humans.txt b/humans.txt index 2e389d7de15..f7968abd303 100644 --- a/humans.txt +++ b/humans.txt @@ -5,4 +5,4 @@ Contributors: https://github.com/endoflife-date/endoflife.date/graphs/contributo /* SITE */ Software: Jekyll, Netlify, GitHub, Ruby, GitHub Actions -Components: Just the Docs Jekyll Theme, Stoplight Elements +Components: Just the Docs Jekyll Theme, Stoplight Elements, Simple Icons, Openmoji diff --git a/manifest.json b/manifest.json new file mode 100644 index 00000000000..030fcb5ae38 --- /dev/null +++ b/manifest.json @@ -0,0 +1,23 @@ +--- +# See https://web.dev/add-manifest/ +--- +{ + "name": "", + "short_name": "", + "icons": [ + { + "src": "{{ '/assets/logo-192x192.png' | absolute_url }}", + "sizes": "192x192", + "type": "image/png" + }, + { + "src": "{{ '/assets/logo-512x512.png' | absolute_url }}", + "sizes": "512x512", + "type": "image/png" + } + ], + "start_url": "{{ '/' | absolute_url }}?utm_source=homescreen", + "theme_color": "#ffffff", + "background_color": "#ffffff", + "display": "standalone" +}