Skip to content

api docs: add breadcrumbs #1068

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.

Sign up for GitHub

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 2 commits into from
Jul 9, 2025
Merged

api docs: add breadcrumbs #1068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73dd482
api docs: add breadcrumbs
aspeddro Jul 5, 2025
2f391a7
string interpolation
aspeddro Jul 9, 2025
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
9 changes: 5 additions & 4 deletions src/ApiDocs.res
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,14 +370,15 @@ let default = (props: props) => {
| Error(_) => React.null
}

let prefix = {
{Url.name: "API", href: "/docs/manual/" ++ (version ++ "/api")}
}
let prefix = {Url.name: "API", href: "/docs/manual/" ++ (version ++ "/api")}

let breadcrumbs = ApiLayout.makeBreadcrumbs(~prefix, router.asPath)

<SidebarLayout
breadcrumbs
breadcrumbs={list{
{Url.name: "Docs", href: "/docs/manual/" ++ version ++ "/introduction"},
...breadcrumbs,
}}
metaTitle={title ++ " | ReScript API"}
theme=#Reason
components=ApiMarkdown.default
Expand Down
7 changes: 6 additions & 1 deletion src/layouts/ApiOverviewLayout.res
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,12 @@ module Docs = {

let categories = makeCategories(version)

<ApiLayout categories version components>
let breadcrumbs = list{
{Url.name: "Docs", href: `/docs/manual/${version}/introduction`},
{name: "API", href: `/docs/manual/${version}/api`},
}

<ApiLayout breadcrumbs categories version components>
{switch version {
| "v9.0.0" | "v8.0.0" => <ApiLayout.OldDocsWarning route version />
| _ => React.null
Expand Down