Skip to content

Render docs nav labels as their authors wrote them #5621

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

Open
dimitrieh wants to merge 1 commit into
base: docs/prev-next-links
Choose a base branch
from
Open

Render docs nav labels as their authors wrote them #5621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion nuxt/components/Breadcrumbs.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ useSchemaOrg([
</script>

<template>
<!-- No `capitalize`: every crumb is an authored page title, so capitalising each word only
mangles them, the same way it did in the sidebar. -->
<UBreadcrumb
:items="items"
color="neutral"
class="capitalize"
:ui="{ link: 'text-sm hover:text-indigo-600' }"
>
<template #separator>
Expand Down
6 changes: 5 additions & 1 deletion src/css/style.handbook.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,13 @@
@apply flex flex-col-reverse lg:grid lg:max-w-screen-xl 2xl:max-w-[1920px] 2xl:grid-cols-[300px,minmax(0,1fr),270px];
}

/* No text-transform here: labels render as the docs authors wrote them. Capitalising every
word made a section named after its directory look like a word ("install" -> "Install"),
which is no longer how any label is produced, and it mangled the rest: "Upgrading the
Node-RED version" became "Upgrading The Node-RED Version", and Bosch Rexroth's ctrlX
became CtrlX. 42 of the sidebar's 117 labels were altered this way. */
.handbook-nav {
border-right: 1px solid right;
text-transform: capitalize;
--nav-weight: 500;
--nav-color: var(--color-gray-700);
--nav-bg: transparent;
Expand Down
Loading