Skip to content

add docsearch metatag version #809

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

Merged
merged 1 commit into from
Feb 5, 2024
Merged
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
2 changes: 1 addition & 1 deletion src/common/App.res
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ let make = (props: props): React.element => {
}
let description = Belt.Option.flatMap(fm, fm => Js.Null.toOption(fm.description))
<MainLayout>
<Meta ?title ?description />
<Meta ?title ?description version=url.version />
<div className="flex justify-center">
<div className="max-w-740 w-full"> content </div>
</div>
Expand Down
9 changes: 9 additions & 0 deletions src/components/Meta.res
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ let make = (
~ogDescription=description,
~ogTitle=?,
~ogImage=?,
~version: option<Url.version>=?,
) => {
let title = switch title {
| None
Expand Down Expand Up @@ -68,5 +69,13 @@ let make = (
/* TODO: Undo this later */
/* <meta key="twitter:image" property="twitter:image" content=ogImage /> */
<link rel="alternate" type_="application/rss+xml" title="ReScript Blog" href="/blog/feed.xml" />
// Docsearch meta tags
<meta
name="docsearch:version"
content={switch version {
| Some(Version(v)) => v
| _ => "latest"
}}
/>
</Head>
}
1 change: 1 addition & 0 deletions src/components/Meta.resi
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ let make: (
~ogDescription: string=?,
~ogTitle: string=?,
~ogImage: string=?,
~version: Url.version=?,
) => React.element
2 changes: 1 addition & 1 deletion src/layouts/DocsLayout.res
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ let make = (
metaTitle ++ (" | " ++ titleCategory)
| None => title
}
let meta = <Meta title ?description ?canonical />
let meta = <Meta title ?description ?canonical version=Url.parse(router.route).version />

let ghEditHref = switch canonical {
| Some(canonical) =>
Expand Down
3 changes: 2 additions & 1 deletion src/layouts/SidebarLayout.res
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,7 @@ let make = (
) => {
let (isNavOpen, setNavOpen) = React.useState(() => false)
let router = Next.Router.useRouter()
let version = Url.parse(router.route).version

let theme = ColorTheme.toCN(theme)

Expand Down Expand Up @@ -297,7 +298,7 @@ let make = (
}

<>
<Meta title=metaTitle />
<Meta title=metaTitle version />
<div className={"mt-16 min-w-320 " ++ theme}>
<div className="w-full">
<Navigation overlayState=(isNavOpen, setNavOpen) />
Expand Down