Skip to content
Open
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The documentation is built by the static-site-generator [Hugo](https://gohugo.io

Clone repository:
```shell
git clone --recurse-submodules git@github.com:cedardb/docs.git
git clone git@github.com:cedardb/docs.git
```

Run a web server:
Expand Down
66 changes: 34 additions & 32 deletions assets/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -48,22 +48,24 @@ article,
}

@media (min-width: 48rem) {
.sidebar-container {
.hextra-sidebar-container {
background: transparent !important;
}
}

a {
color: var(--cedar-accent);
text-decoration-thickness: 0.08em;
text-underline-offset: 3px;
text-decoration-color: transparent;
transition: text-decoration-color 0.15s ease;
}
@layer base {
a {
color: var(--cedar-accent);
text-decoration-thickness: 0.08em;
text-underline-offset: 3px;
text-decoration-color: transparent;
transition: text-decoration-color 0.15s ease;
}

a:hover,
a:focus-visible {
text-decoration-color: currentColor;
a:hover,
a:focus-visible {
text-decoration-color: currentColor;
}
}

h1,
Expand All @@ -72,7 +74,7 @@ h3,
h4,
h5,
h6,
.nav-container,
.hextra-nav-container,
.cedar-home__eyebrow,
.cedar-home__index,
.cedar-home__button {
Expand All @@ -91,22 +93,22 @@ kbd,
}


.nav-container {
.hextra-nav-container {
padding: 0;
border-bottom: 1px solid var(--cedar-line);
background: rgba(255, 255, 255, 0.96);
}

.nav-container-blur {
.hextra-nav-container-blur {
background: rgba(255, 255, 255, 0.88);
}

.dark .nav-container,
.dark .nav-container-blur {
.dark .hextra-nav-container,
.dark .hextra-nav-container-blur {
background: rgba(13, 21, 34, 0.96);
}

.nav-container nav {
.hextra-nav-container nav {
height: 4rem;
max-width: var(--cedar-max);
}
Expand All @@ -120,39 +122,39 @@ kbd,
color: var(--cedar-accent);
}

.search-wrapper button,
.search-wrapper input {
.hextra-search-wrapper button,
.hextra-search-wrapper input {
border-color: var(--cedar-line) !important;
border-radius: 0 !important;
background: transparent !important;
box-shadow: none !important;
}

.sidebar-container,
.toc {
.hextra-sidebar-container,
.hextra-toc {
backdrop-filter: none;
}

.sidebar-container .hextra-scrollbar,
.hextra-sidebar-container .hextra-scrollbar,
.hextra-toc > div,
.hextra-toc .sticky,
.sidebar-container [data-toggle-animation="show"] {
.hextra-sidebar-container [data-toggle-animation="show"] {
background: transparent !important;
box-shadow: none !important;
border-top-color: var(--cedar-line) !important;
}

.sidebar-container a,
.toc a,
.hextra-sidebar-container a,
.hextra-toc a,
.content {
color: inherit;
}

.sidebar-container a {
.hextra-sidebar-container a {
border-radius: 0 !important;
}

.sidebar-container {
.hextra-sidebar-container {
border-right: 1px solid var(--cedar-line);
}

Expand All @@ -165,18 +167,18 @@ kbd,
padding: 8px;
}

.sidebar-active-item {
.hextra-sidebar-active-item {
border-left: 0;
box-shadow: inset 2px 0 0 var(--cedar-accent);
background: rgba(251, 119, 62, 0.04) !important;
}

.dark .sidebar-active-item {
.dark .hextra-sidebar-active-item {
background: rgba(251, 119, 62, 0.08) !important;
}

.sidebar-container > div,
.toc > div,
.hextra-sidebar-container > div,
.hextra-toc > div,
.content pre,
.content blockquote,
.hextra-card,
Expand Down Expand Up @@ -801,7 +803,7 @@ dd {
}

@media (max-width: 767px) {
.nav-container {
.hextra-nav-container {
padding-top: 0;
}

Expand Down
2 changes: 1 addition & 1 deletion content/clients/tools/psql.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ You can also show a list of all tables in the current database:
Most commands also have a more verbose variant with a `+` (e.g., `\d+`), which will show more details like the table
size in bytes.
For a full list of psql backslash commands, see the
[psql docs]((https://www.postgresql.org/docs/current/app-psql.html)).
[psql docs](https://www.postgresql.org/docs/current/app-psql.html).

## Using psql interactively

Expand Down
4 changes: 2 additions & 2 deletions content/technology/parallelism.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ available hardware resources to a single query, resulting in low overall utiliza


<div class="columns-2">
<div class="w-full"> {{< asciinema key="htop_cedardb" scale="width" autoPlay=true >}} </div>
<div class="w-full"> {{< asciinema key="htop_postgresql" autoPlay=true >}} </div>
<div class="hx:w-full"> {{< asciinema key="htop_cedardb" scale="width" autoPlay=true >}} </div>
<div class="hx:w-full"> {{< asciinema key="htop_postgresql" autoPlay=true >}} </div>
</div>


Expand Down
10 changes: 5 additions & 5 deletions layouts/docs/list.html
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
{{ define "main" }}
{{ if .IsHome }}
<div class='cedar-home-page mx-auto flex {{ partial "utils/page-width" . }}'>
<div class='cedar-home-page hx:mx-auto hextra-max-page-width'>
{{ partial "sidebar.html" (dict "context" .) }}
<main class="cedar-home-main">
{{ .Content }}
</main>
</div>
{{ else }}
<div class='mx-auto flex {{ partial "utils/page-width" . }}'>
<div class='hx:mx-auto hx:flex hextra-max-page-width'>
{{ partial "sidebar.html" (dict "context" .) }}
{{ partial "toc.html" . }}
<article class="cedar-docs-article w-full break-words flex min-w-0 justify-center pb-8">
<main class="w-full min-w-0 max-w-6xl px-6 pt-4 md:px-12">
<article class="cedar-docs-article hx:w-full hx:break-words hx:flex hx:min-w-0 hx:justify-center hx:pb-8">
<main class="hx:w-full hx:min-w-0 hx:max-w-6xl hx:px-6 hx:pt-4 md:px-12">
<div class="cedar-docs-breadcrumb">
{{ partial "breadcrumb.html" . }}
{{ partial "breadcrumb.html" (dict "page" . "enable" true) }}
</div>
<div class="content">
<h1>{{ .Title }}</h1>
Expand Down
8 changes: 4 additions & 4 deletions layouts/docs/single.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{{ define "main" }}
<div class='mx-auto flex {{ partial "utils/page-width" . }}'>
<div class='hx:mx-auto hx:flex hextra-max-page-width'>
{{ partial "sidebar.html" (dict "context" .) }}
{{ partial "toc.html" . }}
<article class="cedar-docs-article w-full break-words flex min-w-0 justify-center pb-8">
<main class="w-full min-w-0 max-w-6xl px-6 pt-4 md:px-12">
<article class="cedar-docs-article hx:w-full hx:break-words hx:flex hx:min-w-0 hx:justify-center hx:pb-8">
<main class="hx:w-full hx:min-w-0 hx:max-w-6xl hx:px-6 hx:pt-4 md:px-12">
<div class="cedar-docs-breadcrumb">
{{ partial "breadcrumb.html" . }}
{{ partial "breadcrumb.html" (dict "page" . "enable" true) }}
</div>
<div class="content">
<h1>{{ .Title }}</h1>
Expand Down
2 changes: 1 addition & 1 deletion layouts/hextra-home.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{ define "main" }}
<div class='cedar-home-page mx-auto flex {{ partial "utils/page-width" . }}'>
<div class='cedar-home-page hx:mx-auto hextra-max-page-width'>
{{ partial "sidebar.html" (dict "context" .) }}
<main class="cedar-home-main">
{{ .Content }}
Expand Down
2 changes: 1 addition & 1 deletion layouts/index.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{ define "main" }}
<div class='cedar-home-page mx-auto flex {{ partial "utils/page-width" . }}'>
<div class='cedar-home-page hx:mx-auto hextra-max-page-width'>
{{ partial "sidebar.html" (dict "context" .) }}
<main class="cedar-home-main">
{{ .Content }}
Expand Down
6 changes: 3 additions & 3 deletions layouts/partials/footer.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<footer class="cedar-footer print:hidden">
<footer class="cedar-footer hx:print:hidden">
<div class="cedar-footer__inner">
<div class="cedar-footer__brand">
<a href="https://cedardb.com/" class="cedar-footer__logo" aria-label="CedarDB">
<img class="block dark:hidden" src="{{ "logos/cedardb.svg" | relURL }}" alt="CedarDB" width="180" height="20" />
<img class="hidden dark:block" src="{{ "logos/cedardb_dark.svg" | relURL }}" alt="CedarDB" width="180" height="20" />
<img class="hx:block hx:dark:hidden" src="{{ "logos/cedardb.svg" | relURL }}" alt="CedarDB" width="180" height="20" />
<img class="hx:hidden hx:dark:block" src="{{ "logos/cedardb_dark.svg" | relURL }}" alt="CedarDB" width="180" height="20" />
</a>
<p class="cedar-footer__copy">Documentation for installing, connecting, and operating CedarDB.</p>
</div>
Expand Down
68 changes: 28 additions & 40 deletions layouts/partials/navbar.html
Original file line number Diff line number Diff line change
@@ -1,36 +1,27 @@
{{- $logoPath := .Site.Params.navbar.logo.path | default "images/logo.svg" -}}
{{- $logoLink := .Site.Params.navbar.logo.link | default .Site.Home.RelPermalink -}}
{{- $logoWidth := .Site.Params.navbar.logo.width | default "20" -}}
{{- $logoHeight := .Site.Params.navbar.logo.height | default "20" -}}
{{- $logoDarkPath := .Site.Params.navbar.logo.dark | default $logoPath -}}

{{- $navWidth := "max-w-[90rem]" -}}
{{- $navWidth := "hx:max-w-[90rem]" -}}
{{- with .Site.Params.navbar.width -}}
{{ if eq . "normal" -}}
{{ $navWidth = "max-w-screen-xl" -}}
{{ $navWidth = "hx:max-w-screen-xl" -}}
{{ else if eq . "full" -}}
{{ $navWidth = "max-w-full" -}}
{{ end -}}
{{- end -}}

<div class="nav-container sticky top-0 z-20 w-full bg-transparent print:hidden">
<div class="nav-container-blur pointer-events-none absolute z-[-1] h-full w-full bg-white dark:bg-dark shadow-[0_2px_4px_rgba(0,0,0,.02),0_1px_0_rgba(0,0,0,.06)] contrast-more:shadow-[0_0_0_1px_#000] dark:shadow-[0_-1px_0_rgba(255,255,255,.1)_inset] contrast-more:dark:shadow-[0_0_0_1px_#fff]"></div>
{{- $page := . -}}
{{- $iconHeight := 24 -}}

<div class="hextra-nav-container hx:sticky hx:top-0 hx:z-20 hx:w-full hx:bg-transparent hx:print:hidden">
<div
class="hextra-nav-container-blur hx:pointer-events-none hx:absolute hx:z-[-1] hx:h-full hx:w-full hx:bg-white hx:dark:bg-dark hx:shadow-[0_2px_4px_rgba(0,0,0,.02),0_1px_0_rgba(0,0,0,.06)] hx:contrast-more:shadow-[0_0_0_1px_#000] hx:dark:shadow-[0_-1px_0_rgba(255,255,255,.1)_inset] hx:contrast-more:dark:shadow-[0_0_0_1px_#fff]"
></div>

<nav class="mx-auto flex items-center justify-end gap-2 h-16 px-6 {{ $navWidth }}">
<a class="flex items-center hover:opacity-75 ltr:mr-auto rtl:ml-auto" href="{{ $logoLink }}">
{{- if (.Site.Params.navbar.displayLogo | default true) }}
<img class="block dark:hidden" src="{{ $logoPath | relURL }}" alt="{{ .Site.Title }}" height="{{ $logoHeight }}" width="{{ $logoWidth }}" />
<img class="hidden dark:block" src="{{ $logoDarkPath | relURL }}" alt="{{ .Site.Title }}" height="{{ $logoHeight }}" width="{{ $logoWidth }}" />
{{- end }}
{{- if (.Site.Params.navbar.displayTitle | default true) }}
<span class="mx-2 font-extrabold inline select-none" title="{{ .Site.Title }}">{{- .Site.Title -}}</span>
{{- end }}
</a>
<nav class="hextra-max-navbar-width hx:mx-auto hx:flex hx:items-center hx:justify-end hx:gap-2 hx:h-16 hx:px-6">
{{ partial "navbar-title.html" . }}

{{- $currentPage := . -}}
{{- range .Site.Menus.main -}}
{{- if eq .Params.type "search" -}}
{{- partial "search.html" (dict "params" .Params) -}}
{{- partial "search.html" (dict "params" .Params "location" "navbar") -}}
{{- else -}}
{{- $link := .URL -}}
{{- $external := strings.HasPrefix $link "http" -}}
Expand All @@ -40,32 +31,29 @@
{{- end -}}
{{- end -}}

{{/* Display icon menu item */}}
{{- if .Params.icon -}}
{{- $rel := cond (eq .Params.icon "mastodon") "noreferer me" "noreferer" }}
<a class="p-2 text-current" {{ if $external }}target="_blank" rel="{{ $rel }}"{{ end }} href="{{ $link }}" title="{{ or (T .Identifier) .Name | safeHTML }}">
{{- partial "utils/icon.html" (dict "name" .Params.icon "attributes" "height=24") -}}
<span class="sr-only">{{ or (T .Identifier) .Name | safeHTML }}</span>
{{- if eq .Params.type "link" -}}
{{- partial "navbar-link.html" (dict "currentPage" $currentPage "link" $link "external" $external "item" . "icon" .Params.icon) -}}
{{- else if eq .Params.type "theme-toggle" -}}
{{- partial "theme-toggle.html" (dict "iconHeight" $iconHeight "hideLabel" (not .Params.label) "iconHeight" $iconHeight "location" "top" "class" "hx:p-2") -}}
{{- else if eq .Params.type "language-switch" -}}
{{- partial "language-switch" (dict "context" $page "grow" false "hideLabel" (not .Params.label) "iconName" (.Params.icon | default "translate") "iconHeight" $iconHeight "location" "top" "class" "hx:p-2") -}}
{{- else if .Params.icon -}}
{{- /* Display icon menu item */ -}}
{{- if not $link -}}{{ warnf "Icon menu item '%s' has no URL" .Name }}{{- end -}}
{{- $rel := cond (eq .Params.icon "mastodon") "noreferrer me" "noreferrer" }}
<a class="hx:p-2 hx:text-current" {{ if $external }}target="_blank" rel="{{ $rel }}"{{ end }} href="{{ $link }}" title="{{ or (T .Identifier) .Name | safeHTML }}">
{{- partial "utils/icon.html" (dict "name" .Params.icon "attributes" (printf "height=%d" $iconHeight)) -}}
<span class="hx:sr-only">{{ or (T .Identifier) .Name | safeHTML }}</span>
</a>
{{- else -}}
{{- $active := or ($currentPage.HasMenuCurrent "main" .) ($currentPage.IsMenuCurrent "main" .) -}}
{{- $activeClass := cond $active "font-medium" "text-gray-600 hover:text-gray-800 dark:text-gray-400 dark:hover:text-gray-200" -}}
<a
title="{{ or (T .Identifier) .Name | safeHTML }}"
href="{{ $link }}"
{{ if $external }}target="_blank" rel="noreferer"{{ end }}
class="nav-text-link text-sm contrast-more:text-gray-700 contrast-more:dark:text-gray-100 relative -ml-2 hidden whitespace-nowrap p-2 md:inline-block {{ $activeClass }}"
>
<span class="text-center">{{ or (T .Identifier) .Name | safeHTML }}</span>
</a>
{{- partial "navbar-link.html" (dict "currentPage" $currentPage "link" $link "external" $external "item" .) -}}
{{- end -}}
{{- end -}}
{{- end -}}

{{ partial "theme-toggle.html" (dict "hideLabel" true) }}

<button type="button" aria-label="Menu" class="hamburger-menu -mr-2 rounded p-2 active:bg-gray-400/20 md:hidden">
{{- partial "utils/icon.html" (dict "name" "hamburger-menu" "attributes" "height=24") -}}
<button type="button" aria-label="{{ (T "menu") | default "Menu" }}" aria-expanded="false" class="hextra-hamburger-menu hx:cursor-pointer hx:-mr-2 hx:rounded-sm hx:p-2 hx:active:bg-gray-400/20 hx:md:hidden hx:hextra-focus-visible-inset">
{{- partial "utils/icon.html" (dict "name" "hamburger-menu" "attributes" (printf "height=%d" $iconHeight)) -}}
</button>
</nav>
</div>
Loading