Skip to content

Commit

Permalink
docs: social previews (#730)
Browse files Browse the repository at this point in the history
## 📜 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>
  • Loading branch information
kirillzyusko and github-actions[bot] authored Dec 16, 2024
1 parent f81c193 commit 9743613
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const config = {
baseUrl: baseUrl,
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
favicon: "img/favicon.ico",
favicon: "favicon.ico",

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
Expand Down Expand Up @@ -105,6 +105,11 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
image: "img/og-image.png",
metadata: [
{ name: "og:image:width", content: "2400" },
{ name: "og:image:height", content: "1426" },
],
navbar: {
title: "Keyboard Controller",
logo: {
Expand Down
File renamed without changes.
Binary file added docs/static/img/og-image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9743613

Please sign in to comment.