diff --git a/README.md b/README.md index 9899f2c59..5a4fc43ef 100644 --- a/README.md +++ b/README.md @@ -422,6 +422,166 @@ Parameters for banner shortcode:
+#### 🧩 Congratulations-banner + +![](readme-assets/shortcode-congratulations-banner.png) + +Example: +``` +{{< congratulations-banner +title="Congratulations!" +description="You’ve reached the end of Day 0!" >}} +``` + +Parameters for congratulations-banner shortcode: +- `title` - required +- `description` - required +- `image` - optional, default "/img/congratulations.svg" + +
+ +#### 🧩 List + +- List - variant 1 + +![](readme-assets/shortcode-list-1.png) + +Example: +``` +{{< list isCompleted="false" >}} +- Set up your Qdrant Cloud account +- Created your first Qdrant collection +- Inserted vectors with metadata +- Performed a similarity search +{{< /list >}} +``` + +- List - variant 2 + +![](readme-assets/shortcode-list-2.png) + +Example: +``` +{{< list isCompleted="true" >}} +- Set up your Qdrant Cloud account +- Created your first Qdrant collection +- Inserted vectors with metadata +- Performed a similarity search +{{< /list >}} +``` + +Parameters for list shortcode: +- `isCompleted` - optional, default "false" + +
+ +#### 🧩 Course card + +- Course-card - variant 1 + +![](readme-assets/shortcode-course-card-1.png) + +Example: +``` +{{< course-card +title="Skills you’ll gain:" +image="/icons/outline/training-white.svg" +isWideList="true">}} +- Vector search fundamentals +- Performance optimization +- Hybrid and similarity search +- Portfolio project development +{{< /course-card >}} +``` + +- Course-card - variant 2 + +![](readme-assets/shortcode-course-card-2.png) + +Example: +``` +{{< course-card +title="Why Start Today" +image="/icons/outline/rocket-white-light.svg" +link="/course/day-0/">}} +- Seeing practical examples (e.g., hybrid search, sparse+dense vectors) +- Learning key deployment tactics (multi-node clusters, on-disk indexing, RBAC) +- Building a final portfolio-grade project to showcase +{{< /course-card >}} +``` + +Parameters for course card shortcode: +- `title` - required +- `isWideList` - optional, default "false" +- `image` - optional, default "/icons/outline/training-white.svg" +- `link` - optional, default null + +
+ +#### 🧩 Date + +![](readme-assets/shortcode-date.png) + +Example: +``` +{{< date >}} Day 1 {{< /date >}} +``` + +Parameters for date shortcode: +- `image` - optional, default "/icons/outline/date-blue.svg" + +
+ +#### 🧩 Cards list + +![](readme-assets/shortcode-cards-list.png) + +Example: +``` +{{< cards-list >}} +- icon: /courses/course-integrations/quotient.svg + title: Quotient + content: Qdrant is compatible with Cohere co.embed API. + +- icon: /courses/course-integrations/superlinked.svg + title: Superlinked + content: Qdrant is compatible with Cohere co.embed API. + +- icon: /courses/course-integrations/twelveLabs.svg + title: TwelveLabs + content: Qdrant is compatible with Cohere co.embed API. + +- icon: /courses/course-integrations/aparavi.svg + title: APARAVI + content: Qdrant is compatible with Cohere co.embed API. +{{< /cards-list >}} +``` + +
+ +#### 🧩 Accordion + +![](readme-assets/shortcode-accordion.png) + +Example: +``` +{{< accordion >}} +- title: "Days 0: Setup, Orientation & “Hello Qdrant!”" + content: | + - Welcome & Course Orientation + - Environment Setup + - Mini “Hello Qdrant!” Demo + +- title: "Day 1: Core Qdrant Data Model & Vector Search 101" + content: Content + +- title: "Days 2: Indexing & Vector Storage Architecture" + content: Content +{{< /accordion >}} +``` + +
+ #### 🧩 Code Snippets Widget ![](readme-assets/shortcode-snippets.png) @@ -509,4 +669,4 @@ When use `seo_schema` and `seo_schema_json` together, `seo_schema` will be used Use `seo_schema_json` if you want to reuse the same schema for multiple pages to avoid duplication and make it easier to maintain. -[To Index](#index) \ No newline at end of file +[To Index](#index) diff --git a/qdrant-landing/content/course/essentials/_index.md b/qdrant-landing/content/course/essentials/_index.md index 9ef75ceb3..b9979b666 100644 --- a/qdrant-landing/content/course/essentials/_index.md +++ b/qdrant-landing/content/course/essentials/_index.md @@ -26,13 +26,11 @@ From your first vector upsert to optimizing high-performance retrieval at scale, {{< course-card title="Skills you’ll gain:" image="/icons/outline/training-white.svg" -type="wide-list">}} - +isWideList="true">}} - Vector search fundamentals - Performance optimization - Hybrid and similarity search - Portfolio project development - {{< /course-card >}} ## What Is the Course? @@ -101,9 +99,7 @@ Optional but helpful: title="Why Start Today" image="/icons/outline/rocket-white-light.svg" link="/course/day-0/">}} - - Seeing practical examples (e.g., hybrid search, sparse+dense vectors) - Learning key deployment tactics (multi-node clusters, on-disk indexing, RBAC) - Building a final portfolio-grade project to showcase - {{< /course-card >}} diff --git a/qdrant-landing/themes/qdrant-2024/assets/css/components/_accordion.scss b/qdrant-landing/themes/qdrant-2024/assets/css/components/_accordion.scss index 0591b98dd..46e07b876 100644 --- a/qdrant-landing/themes/qdrant-2024/assets/css/components/_accordion.scss +++ b/qdrant-landing/themes/qdrant-2024/assets/css/components/_accordion.scss @@ -33,7 +33,8 @@ top: calc(50% - pxToRem(9)); height: pxToRem(18); width: pxToRem(16); - background-image: url("data:image/svg+xml,%3Csvg width='17' height='19' viewBox='0 0 17 19' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cg clip-path='url(%23clip0_10609_1497)'%3E%3Cpath d='M1.81787 6.50513L8.63605 13.3233L15.4542 6.50513' stroke='%23E1E5F0' stroke-width='1.36364' stroke-linecap='round' stroke-linejoin='round'/%3E%3C/g%3E%3Cdefs%3E%3CclipPath id='clip0_10609_1497'%3E%3Crect width='16.3636' height='16.3636' fill='white' transform='translate(0.63623 1.91431)'/%3E%3C/clipPath%3E%3C/defs%3E%3C/svg%3E%0A");background-position: center; + background-image: url("data:image/svg+xml,%3Csvg width='17' height='19' viewBox='0 0 17 19' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cg clip-path='url(%23clip0_10609_1497)'%3E%3Cpath d='M1.81787 6.50513L8.63605 13.3233L15.4542 6.50513' stroke='%23E1E5F0' stroke-width='1.36364' stroke-linecap='round' stroke-linejoin='round'/%3E%3C/g%3E%3Cdefs%3E%3CclipPath id='clip0_10609_1497'%3E%3Crect width='16.3636' height='16.3636' fill='white' transform='translate(0.63623 1.91431)'/%3E%3C/clipPath%3E%3C/defs%3E%3C/svg%3E%0A"); + background-position: center; background-repeat: no-repeat; background-size: cover; } @@ -48,6 +49,10 @@ padding: 0 $spacer * 2 $spacer * 2 $spacer * 2; color: $neutral-70; + [data-theme='light'] & { + color: $neutral-70; + } + ul { li:not(:last-of-type) { margin-bottom: pxToRem(10); @@ -57,8 +62,8 @@ } &.active { - .accordion__item-header:after { - background-image: url("data:image/svg+xml,%3Csvg width='17' height='19' viewBox='0 0 17 19' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cg clip-path='url(%23clip0_10609_1581)'%3E%3Cpath d='M15.4546 13.3232L8.63641 6.50506L1.81823 13.3232' stroke='%23E1E5F0' stroke-width='1.36364' stroke-linecap='round' stroke-linejoin='round'/%3E%3C/g%3E%3Cdefs%3E%3CclipPath id='clip0_10609_1581'%3E%3Crect width='16.3636' height='16.3636' fill='white' transform='translate(0.63623 1.91418)'/%3E%3C/clipPath%3E%3C/defs%3E%3C/svg%3E%0A"); + .accordion-dark__item-header:after { + background-image: url("data:image/svg+xml,%3Csvg width='17' height='19' viewBox='0 0 17 19' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cg clip-path='url(%23clip0_10854_1606)'%3E%3Cpath d='M15.4546 13.3232L8.63641 6.50506L1.81823 13.3232' stroke='%23E1E5F0' stroke-width='1.36364' stroke-linecap='round' stroke-linejoin='round'/%3E%3C/g%3E%3Cdefs%3E%3CclipPath id='clip0_10854_1606'%3E%3Crect width='16.3636' height='16.3636' fill='white' transform='translate(0.63623 1.91418)'/%3E%3C/clipPath%3E%3C/defs%3E%3C/svg%3E%0A"); } } } diff --git a/qdrant-landing/themes/qdrant-2024/assets/css/components/_course-card.scss b/qdrant-landing/themes/qdrant-2024/assets/css/components/_course-card.scss index 454d4749e..c8c6826a8 100644 --- a/qdrant-landing/themes/qdrant-2024/assets/css/components/_course-card.scss +++ b/qdrant-landing/themes/qdrant-2024/assets/css/components/_course-card.scss @@ -29,20 +29,8 @@ } &__content { - color: $neutral-70; - - &.wide { - ul { - -webkit-column-count: 2; - -moz-column-count: 2; - column-count: 2; - column-gap: $spacer * 6; - margin-bottom: -$spacer * 1.5; - - li { - margin-bottom: $spacer * 1.5; - } - } + [data-theme='light'] & { + color: $neutral-70; } } diff --git a/qdrant-landing/themes/qdrant-2024/assets/css/components/_list.scss b/qdrant-landing/themes/qdrant-2024/assets/css/components/_list.scss index c61cff630..d0b942aff 100644 --- a/qdrant-landing/themes/qdrant-2024/assets/css/components/_list.scss +++ b/qdrant-landing/themes/qdrant-2024/assets/css/components/_list.scss @@ -30,4 +30,37 @@ } } } + + &.list-completed { + ul { + li { + padding-left: pxToRem(26); + + &:before { + top: pxToRem(3); + width: pxToRem(18); + height: pxToRem(18); + background-image: url("data:image/svg+xml,%3Csvg width='18' height='18' viewBox='0 0 18 18' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M16.3125 4.875V13.125L9 17.25L1.6875 13.125V4.875L9 0.75L16.3125 4.875ZM12.2559 6.56055L7.7832 10.4727L5.25 7.93945L4.18945 9L7.71582 12.5264L8.24414 12.0645L13.2441 7.68945L13.8086 7.19531L12.8203 6.06641L12.2559 6.56055Z' fill='%23008A53'/%3E%3C/svg%3E%0A"); + } + } + } + } + + &.list-wide { + ul { + -webkit-column-count: 2; + -moz-column-count: 2; + column-count: 2; + column-gap: $spacer * 6; + margin-bottom: -$spacer * 1.5; + + li { + margin-bottom: $spacer * 1.5; + } + } + } + + [data-theme='light'] & { + color: $neutral-30; + } } diff --git a/qdrant-landing/themes/qdrant-2024/assets/css/partials/documentation/_docs.scss b/qdrant-landing/themes/qdrant-2024/assets/css/partials/documentation/_docs.scss index c46a44350..63bf12b11 100644 --- a/qdrant-landing/themes/qdrant-2024/assets/css/partials/documentation/_docs.scss +++ b/qdrant-landing/themes/qdrant-2024/assets/css/partials/documentation/_docs.scss @@ -100,6 +100,13 @@ text-align: center; z-index: 2; + h1 { + font-size: $spacer * 2; + line-height: $spacer * 2.5; + padding: 0; + margin-bottom: math.div($spacer, 2); + } + h3 { font-size: pxToRem(20); line-height: pxToRem(30); @@ -108,6 +115,12 @@ margin-bottom: $spacer * 1.5; } + p { + font-size: pxToRem(18); + line-height: pxToRem(27); + margin-bottom: 0; + } + a { font-size: pxToRem(14); font-weight: 500; @@ -207,6 +220,8 @@ text-align: left; h3, + h1, + p, a { margin-left: $spacer * 2.5; } @@ -256,9 +271,12 @@ } } .docs-core__developing-block { - h3 { + h1, h3 { color: $neutral-98; } + p { + color: $neutral-70; + } .button_outlined { color: $neutral-100; box-shadow: 0 0 0 1px $neutral-60; diff --git a/qdrant-landing/themes/qdrant-2024/layouts/shortcodes/congratulations-banner.html b/qdrant-landing/themes/qdrant-2024/layouts/shortcodes/congratulations-banner.html new file mode 100644 index 000000000..79dc965a1 --- /dev/null +++ b/qdrant-landing/themes/qdrant-2024/layouts/shortcodes/congratulations-banner.html @@ -0,0 +1,15 @@ +{{ $title := .Get "title" }} +{{ $description := .Get "description" }} +{{ $image := default "/img/congratulations.svg" (.Get "image") }} +
+
+
+

{{ $title }}

+

{{ $description }}

+
+
+ +
+
+
+
diff --git a/qdrant-landing/themes/qdrant-2024/layouts/shortcodes/course-card.html b/qdrant-landing/themes/qdrant-2024/layouts/shortcodes/course-card.html index 056d4e81d..cb653fa06 100644 --- a/qdrant-landing/themes/qdrant-2024/layouts/shortcodes/course-card.html +++ b/qdrant-landing/themes/qdrant-2024/layouts/shortcodes/course-card.html @@ -1,5 +1,5 @@ {{ $title := .Get "title" }} -{{ $type := .Get "type" }} +{{ $isWideList := .Get "isWideList" }} {{ $image := default "/icons/outline/training-white.svg" (.Get "image") }} {{ $link := .Get "link" }}
@@ -7,7 +7,7 @@ Icon {{ $title }} -
+
{{ .Inner | markdownify }}
{{ with $link }} diff --git a/qdrant-landing/themes/qdrant-2024/layouts/shortcodes/list.html b/qdrant-landing/themes/qdrant-2024/layouts/shortcodes/list.html new file mode 100644 index 000000000..fdfd03100 --- /dev/null +++ b/qdrant-landing/themes/qdrant-2024/layouts/shortcodes/list.html @@ -0,0 +1,5 @@ +{{ $isCompleted := .Get "isCompleted" }} +
+ {{ .Inner | markdownify }} +
+ diff --git a/qdrant-landing/themes/qdrant-2024/static/img/congratulations.svg b/qdrant-landing/themes/qdrant-2024/static/img/congratulations.svg new file mode 100644 index 000000000..12d5c6aa5 --- /dev/null +++ b/qdrant-landing/themes/qdrant-2024/static/img/congratulations.svg @@ -0,0 +1,67 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/readme-assets/shortcode-accordion.png b/readme-assets/shortcode-accordion.png new file mode 100644 index 000000000..365cff3e3 Binary files /dev/null and b/readme-assets/shortcode-accordion.png differ diff --git a/readme-assets/shortcode-cards-list.png b/readme-assets/shortcode-cards-list.png new file mode 100644 index 000000000..3c1907eb4 Binary files /dev/null and b/readme-assets/shortcode-cards-list.png differ diff --git a/readme-assets/shortcode-congratulations-banner.png b/readme-assets/shortcode-congratulations-banner.png new file mode 100644 index 000000000..02a9c40fd Binary files /dev/null and b/readme-assets/shortcode-congratulations-banner.png differ diff --git a/readme-assets/shortcode-course-card-1.png b/readme-assets/shortcode-course-card-1.png new file mode 100644 index 000000000..0b4fc8cac Binary files /dev/null and b/readme-assets/shortcode-course-card-1.png differ diff --git a/readme-assets/shortcode-course-card-2.png b/readme-assets/shortcode-course-card-2.png new file mode 100644 index 000000000..27472f98a Binary files /dev/null and b/readme-assets/shortcode-course-card-2.png differ diff --git a/readme-assets/shortcode-date.png b/readme-assets/shortcode-date.png new file mode 100644 index 000000000..4364d0e93 Binary files /dev/null and b/readme-assets/shortcode-date.png differ diff --git a/readme-assets/shortcode-list-1.png b/readme-assets/shortcode-list-1.png new file mode 100644 index 000000000..fbef634ff Binary files /dev/null and b/readme-assets/shortcode-list-1.png differ diff --git a/readme-assets/shortcode-list-2.png b/readme-assets/shortcode-list-2.png new file mode 100644 index 000000000..16f6be6e9 Binary files /dev/null and b/readme-assets/shortcode-list-2.png differ