FakerPHP#30 - Added social cards, links and icons (FakerPHP#32)

Rimahoo121 · Jan 3, 2021 · ad9abe9 · ad9abe9
1 parent ab1d9ad
commit ad9abe9
Show file tree

Hide file tree

Showing 13 changed files with 196 additions and 0 deletions.
diff --git a/docs/images/apple-touch-icon.png b/docs/images/apple-touch-icon.png
diff --git a/docs/images/browserconfig.xml b/docs/images/browserconfig.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+    <msapplication>
+        <tile>
+            <square150x150logo src="/mstile-150x150.png"/>
+            <TileColor>#2094f3</TileColor>
+        </tile>
+    </msapplication>
+</browserconfig>
diff --git a/docs/images/favicon-16x16.png b/docs/images/favicon-16x16.png
diff --git a/docs/images/favicon-32x32.png b/docs/images/favicon-32x32.png
diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico
diff --git a/docs/images/icons-192x192.png b/docs/images/icons-192x192.png
diff --git a/docs/images/icons-512x512.png b/docs/images/icons-512x512.png
diff --git a/docs/images/logo.svg b/docs/images/logo.svg
diff --git a/docs/images/mstile-150x150.png b/docs/images/mstile-150x150.png
diff --git a/docs/images/safari-pinned-tab.svg b/docs/images/safari-pinned-tab.svg
diff --git a/docs/manifest.webmanifest b/docs/manifest.webmanifest
@@ -0,0 +1,23 @@
+{
+  "short_name": "FakerPHP",
+  "name": "FakerPHP / Faker",
+  "description": "Documentation for FakerPHP / Faker",
+  "icons": [
+    {
+      "src": "/images/icons-192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "/images/icons-512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": "/",
+  "background_color": "#2e303e",
+  "display": "standalone",
+  "scope": "/",
+  "theme_color": "#2094f3",
+  "shortcuts": []
+}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -7,20 +7,24 @@ edit_uri: https://github.com/FakerPHP/fakerphp.github.io/edit/main/docs/
 
 theme:
   name: material
+  custom_dir: overrides
   font:
     text: 'Nunito'
     code: 'Fira Code'
   palette:
     scheme: preference
     primary: blue
     accent: blue
+  favicon: images/favicon.ico
+  logo: images/logo.svg
   icon:
     repo: fontawesome/brands/github
   language: en
   features:
     - navigation.instant
 
 extra:
+  manifest: manifest.webmanifest
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/FakerPHP/Faker
@@ -119,6 +123,7 @@ nav:
 
 markdown_extensions:
   - admonition: { }
+  - meta: { }
   - toc:
       permalink: '#'
   - pymdownx.details: { }

diff --git a/overrides/main.html b/overrides/main.html
@@ -0,0 +1,27 @@
+{% extends "base.html" %}
+
+{% block extrahead %}
+<link rel="icon" type="image/png" sizes="32x32" href="/images/favicon-32x32.png">
+<link rel="icon" type="image/png" sizes="16x16" href="/images/favicon-16x16.png">
+<link rel="apple-touch-icon" sizes="180x180" href="/images/apple-touch-icon.png">
+<link rel="mask-icon" href="/images/safari-pinned-tab.svg" color="#2094f3">
+<meta name="msapplication-TileColor" content="#2094f3">
+<meta name="theme-color" content="#2094f3">
+
+{% set title = config.site_name %}
+{% if page and page.meta and page.meta.title %}
+    {% set title = title ~ " - " ~ page.meta.title %}
+{% elif page and page.title and not page.is_homepage %}
+    {% set title = title ~ " - " ~ page.title | striptags %}
+{% endif %}
+
+<meta property="og:title" content="{{ title }}">
+<meta property="og:type" content="website" />
+<meta property="og:description" content="{{ config.site_description }}">
+<meta property="og:url" content="{{ page.canonical_url }}">
+<meta property="og:image" content="https://github.com/FakerPHP/Artwork/raw/main/src/socialcard.png">
+<meta name="twitter:title" content="{{ title }}"/>
+<meta name="twitter:description" content="{{ config.site_description }}"/>
+<meta name="twitter:image" content="https://github.com/FakerPHP/Artwork/raw/main/src/socialcard.png"/>
+<meta name="twitter:card" content="summary_large_image"/>
+{% endblock %}