Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update site logo OPTION 2 [with 'update' Material icon] #1902

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,30 @@ 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 [Material's _update_ icon](https://fonts.google.com/icons?selected=Material+Icons+Outlined:update:). It
is [permitted by Google](https://developers.google.com/fonts/faq#can_i_use_the_font_in_a_logo). Derived icons for
various usages, such as [the web app manifest](/manifest.json) were also generated from Material'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 generated `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`.
Expand Down
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
- [Material Icons](https://fonts.google.com/icons), a collection of icons designed by Google.
- [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
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ defaults:
- scope:
path: ""
values:
image: /logo.png
image: /logo-512.png
- scope:
path: "products"
values:
Expand Down
11 changes: 11 additions & 0 deletions _includes/head_custom.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,14 @@
{% endcapture %}
<meta name="description" content="{{ d | strip }}" />
<meta property="og:description" content="{{ d | strip }}" />

<!-- favicons - see https://realfavicongenerator.net -->
<link rel="apple-touch-icon" sizes="180x180" href="{{ '/assets/apple-touch-icon.png' | relative_url }}">
<link rel="icon" type="image/png" sizes="32x32" href="{{ '/assets/favicon-32x32.png' | relative_url }}">
<link rel="icon" type="image/png" sizes="16x16" href="{{ '/assets/favicon-16x16.png' | relative_url }}">
<link rel="manifest" href="{{ 'manifest.json' | relative_url }}">
<link rel="mask-icon" href="{{ '/assets/safari-pinned-tab.svg' | relative_url }}" color="#5bbad5">
<meta name="msapplication-TileColor" content="#da532c">
<meta name="msapplication-config" content="{{ '/browserconfig.xml' | relative_url }}">
<meta name="theme-color" content="#ffffff">

14 changes: 14 additions & 0 deletions _sass/custom/custom.scss
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,17 @@ body {
}
}
}

.site-title {
margin-left: 1.5rem;

&:before {
content: '';
background:url('/assets/logo-192x192.png');
background-size:cover;
position:absolute;
width: 2rem;
height: 2rem;
margin-left:-2rem;
}
}
Binary file added assets/apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/favicon.ico
Binary file not shown.
Binary file removed assets/icon.png
Binary file not shown.
Binary file added assets/logo-192x192.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/logo-512x512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/logo.png
Binary file not shown.
File renamed without changes
Binary file added assets/mstile-144x144.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/mstile-150x150.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/mstile-310x150.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/mstile-310x310.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/mstile-70x70.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions assets/safari-pinned-tab.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions browserconfig.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
# See https://webmasters.stackexchange.com/q/131077
---
<?xml version="1.0" encoding="utf-8"?>
<browserconfig>
<msapplication>
<tile>
<square150x150logo src="{{ '/assets/mstile-150x150.png' | absolute_url }}"/>
<TileColor>#da532c</TileColor>
</tile>
</msapplication>
</browserconfig>
Binary file added favicon.ico
Binary file not shown.
2 changes: 1 addition & 1 deletion humans.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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, Material Icons
23 changes: 23 additions & 0 deletions manifest.json
Original file line number Diff line number Diff line change
@@ -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"
}