Skip to content

Commit 9743613

Browse files
docs: social previews (#730)
## 📜 Description Enabled favicon in google search and static preview. ## 💡 Motivation and Context I want `keyboard-controller` to be more recognizable. ## 📢 Changelog <!-- High level overview of important changes --> <!-- For example: fixed status bar manipulation; added new types declarations; --> <!-- If your changes don't affect one of platform/language below - then remove this platform/language --> ### Docs - added og preview (main webpage instead of empty); - try to move `favicon.ico` to top level of access (so that it can be indexed by google and show up in search results). ## 🤔 How Has This Been Tested? Tested manually on localhost:3000 ## 📝 Checklist - [x] CI successfully passed - [x] I added new mocks and corresponding unit-tests if library API was changed --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent f81c193 commit 9743613

File tree

3 files changed

+6
-1
lines changed

3 files changed

+6
-1
lines changed

docs/docusaurus.config.js

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const config = {
1919
baseUrl: baseUrl,
2020
onBrokenLinks: "throw",
2121
onBrokenMarkdownLinks: "warn",
22-
favicon: "img/favicon.ico",
22+
favicon: "favicon.ico",
2323

2424
// GitHub pages deployment config.
2525
// If you aren't using GitHub pages, you don't need these.
@@ -105,6 +105,11 @@ const config = {
105105
themeConfig:
106106
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
107107
({
108+
image: "img/og-image.png",
109+
metadata: [
110+
{ name: "og:image:width", content: "2400" },
111+
{ name: "og:image:height", content: "1426" },
112+
],
108113
navbar: {
109114
title: "Keyboard Controller",
110115
logo: {
File renamed without changes.

docs/static/img/og-image.png

125 KB
Loading

0 commit comments

Comments
 (0)