landing_page/README.md

# Index
- [Running locally](#running-locally)
  - [Prerequisites](#prerequisites)
    - [Required](#required)
    - [Needed only for development](#needed-only-for-development)
      - [Updating npm dependencies via hugo](#updating-npm-dependencies-via-hugo)
  - [Run](#run)
  - [Run with drafts](#run-with-drafts)
  - [Build css from scss](#build-css-from-scss)
- [Content Management](#content-management)
  - [Main Page](#main-page)
    - [Customers/Partners Logos](#customerspartners-logos)
  - [Articles](#articles)
    - [Metadata](#metadata)
    - [Preview image mechanism](#preview-image-mechanism)
    - [Article preview](#article-preview)
  - [Documentation](#documentation)
    - [Metadata](#metadata-1)
    - [Preview images for documentation pages](#preview-images-for-documentation-pages)
    - [Documentation sidebar](#documentation-sidebar)
      - [Delimiter](#delimiter)
      - [External link](#external-link)
      - [Params](#params)
  - [Blog](#blog)
    - [Images](#images)
    - [Important notes](#important-notes)
  - [Agenda](#agenda)
  - [Demo](#demo)
    - [Add a demo](#add-a-demo)
    - [Add a filter](#add-a-filter)
  - [Shortcodes 🧩🧩🧩](#shortcodes-)
    - [Built-in shortcodes](#built-in-shortcodes)
    - [Custom shortcodes](#custom-shortcodes)
      - [🧩 Card](#-card)
      - [🧩 Grid Row](#-grid-row)
      - [🧩 Banner](#-banner)
      - [🧩 Code Snippets Widget](#-code-snippets-widget)
        - [📁 Directory Structure](#-directory-structure)
        - [▶️ Example Usage](#-example-usage)
        - [⚙️ Parameters](#-parameters)
        - [⚠️ Notes](#-notes)
        - [🚫 Limitations](#-limitations)



# Running locally

## Prerequisites

### Required

- [Hugo](https://gohugo.io/getting-started/installing/)

### Needed only for development

- [Node.js](https://nodejs.org/en/download/)
- [npm](https://www.npmjs.com/get-npm)
- [Dart Sass](https://sass-lang.com/install) - Don't use the npm package `sass` as it's a different implementation of Sass

#### Updating npm dependencies via hugo

1. Go to `qdrant-landing/themes/qdrant-2024/package.hugo.json` and configure desired versions of npm packages.
2. Run `hugo mod npm pack` to update the `qdrant-landing/themes/qdrant-2024/package.json` file from `qdrant-landing/themes/qdrant-2024` directory.
3. Go to `qdrant-landing` and run `hugo mod npm pack` again to update global `package.json` file.
4. Run `npm install` to install the updated dependencies.



## Run

```bash
./run.sh
```

Open http://localhost:1313/ in your browser.

### Run with drafts

If your changes are not shown on the site, check if your markdown file has `draft: true` in the header.

Drafts are not shown by default. To see drafts, run the following command:

```bash
cd qdrant-landing
hugo serve -D
```

## Build css from scss

For the previous theme, it was required to build CSS files. We don't need to build CSS from SCSS anymore explicitly. It's done automatically by Hugo using Dart Sass, which should be installed on your machine to see results).

# Content Management

To add new content to the site, you need to add a markdown file to the corresponding directory. The file should have a header with metadata. See examples below.

Do not push changes to the `master` branch directly. Create a new branch and make a pull request.

If you want to make your changes live, you need to merge your pull request to the `master` branch. After that, the changes will be automatically deployed to the site.

## Main Page

### Customers/Partners Logos

To add a customer logo to the marquee on the main page:

1. Add a logo to `/qdrant-landing/static/content/images/logos` directory. The logo should be in PNG format and have a transparent background and a width of 200px. The color of the logo should be `#B6C0E4`.

2. Add a markdown file to `content/stack` directory using the next command (replace `customer-name` with the name of the customer):

``` bash
cd qdrant-landing
hugo new --kind customer-logo stack/customer-name.md
```

Edit the file if needed.

3. If the total number of slides changed - update `static/css/main.scss` file. Find line:

```scss
@include marquee.base(80px, 200px, 13, 6, 20px, false, 50s);
```

and change 13 to the number of logos.

Rebuild CSS from SCSS (see instructions [above](#build-css-from-scss)).

4. To change order of the logos - add or change `weight` parameter in the markdown files in `/qdrant-landing/content/stack` directory.


## Articles

### Metadata

Articles are written in markdown and stored in `content/articles` directory. Each article has a header with metadata:

```yaml
---
title: Here goes the title of the article #required
short_description: Short description of the article
description: This is a longer description of the article, you can get a little bit more wordly here. Try to keep it under 140 characters. #required
social_preview_image: /articles_data/cars-recognition/social_preview.jpg # This image will be used in social media previews, should be 1200x630px. Required.
small_preview_image: /articles_data/cars-recognition/icon.svg # This image will be used in the list of articles at the footer, should be 40x40px
preview_dir: /articles_data/cars-recognition/preview # This directory contains images that will be used in the article preview. They can be generated from one image. Read more below. Required.
weight: 10 # This is the order of the article in the list of articles at the footer. The lower the number, the higher the article will be in the list.
author: Yusuf Sarıgöz # Author of the article. Required.
author_link: https://medium.com/@yusufsarigoz # Link to the author's page. Required.
date: 2022-06-28T13:00:00+03:00 # Date of the article. Required.
draft: false # If true, the article will not be published
keywords: # Keywords for SEO
  - vector databases comparative benchmark
  - benchmark
  - performance
  - latency
---
```

### Preview image mechanism

Preview image for each page is selected based on the following places in the following order:

- If the document has param `social_preview_image` - it will be used as the preview image
- If there is a file `static/<path-to-section>/<file-name>-social-preview.png` - it will be used as the preview image
- Global `preview_image = "/images/social_preview.png"` will be used as the preview image

### Article preview

Article preview is a set of images that will be used in the article preview. They can be generated from one image. To generate preview images, you need to have [ImageMagick](https://imagemagick.org/index.php) and [cwebp](https://developers.google.com/speed/webp/download) installed.

You can install `cwebp` with the following command:

```bash
curl -s https://raw.githubusercontent.com/Intervox/node-webp/latest/bin/install_webp | sudo bash
```

For **macOS**, you'll have to install `coreutils` too.

```
brew install coreutils
```

#### Prepare preview image

For the preview use an image with an aspect ratio of 3 to 1 in JPG or PNG format. With a resolution not smaller than 1200x630px. The image should illustrate in some way the article's core idea. Fill free got creative. Check out that the most important part of the image is in the center.

#### Generating preview images

To generate preview images, run the following command from the root of the project:

```bash
bash -x automation/process-article-img.sh <path-to-image> <alias-for-the-article>
```

For example:

```bash
bash -x automation/process-article-img.sh ~/Pictures/my_preview.jpg filterable-hnsw 
```

This command will create a directory `preview` in `static/article_data/filterable-hnsw` and generate preview images in it. If the directory `static/article_data/filterable-hnsw` doesn't exist, it will be created. If it exists, only files in the children `preview` directory will be affected. In this case, preview images will be overwritten. Your original image will not be affected.

For **macOS** you'll have to make 2 adjustements to `process-img.sh` script which is run by `process-article-img.sh` script:

1. Exchange `stat -c %Y` with `stat -f %m`;
2. Exchange `realpath` with `grealpath`.

#### Preview images set

Preview images set consists of the following images:

`preview.jpg` - 530x145px (used on the article preview card **for browsers, not supporting webp**)
`preview.webp` - 530x145px (used on the article preview card **for browsers, supporting webp**)
`title.jpg` - 898x300px (used on the article's page as the main image before the article title **for browsers, not supporting webp**)
`title.webp` - 898x300px (used on the article's page as the main image before the article title **for browsers, supporting webp**)
`social_preview.jpg` - 1200x630px (used in social media previews)

## Documentation

### Metadata

Documentation pages are written in markdown and stored in `content/documentation` directory. Each page has a header with metadata:

```yaml
---
title: Here goes the title of the page #required
weight: 10 # This is the order of the page in the sidebar. The lower the number, the higher the page will be in the sidebar.
canonicalUrl: https://qdrant.io/documentation/ # Optional. This is the canonical URL of the page.
hideInSidebar: true # Optional. If true, the page will not be shown in the sidebar. It can be used in regular documentation pages and in documentation section pages (_index.md).
---
```

### Preview images for documentation pages

Branded individual preview images for documentation pages might be auto-generated using the following command:

(from the root of the project)

```bash
bash -x automation/generate-all-docs-preview.sh
```

It will automatically insert the documentation Section name and Title of the page into the preview.
If there is a custom background for the image - it should be placed in the `static/documentation/<section-name>/<page>-bg.png`.
<!-- (Use midjourney and one of the styles https://www.notion.so/qdrant/Midjourney-styles-a8dbc94761a74bb287a8a8ad05d593d1 to generate the background) -->

If there is no custom background - a random default background will be used.

Generated images will be placed in the `static/documentation/<section-name>/<page>-social-preview.png`.

To re-generate the preview image, remove the previously generated one and re-run the command.

### Documentation sidebar

#### Delimiter

To create a delimiter in the sidebar, use the following command:

``` bash
cd qdrant-landing
hugo new --kind delimiter documentation/<delimiter-title>.md
```

It will create a file `content/documentation/<delimiter-title>.md`.

To put a delimiter to the desired place in the sidebar, set the `weight` parameter to the desired value. The lower the value, the higher the delimiter will be in the sidebar.

#### External link

To create an external link in the sidebar, use the following command:

``` bash
cd qdrant-landing
hugo new --kind external-link documentation/<link-title>.md
```

It will create a file `content/documentation/<link-title>.md`. Open it and set the `external_link` parameter to the desired value.

#### Params

Additionally, to the standard Hugo front matter params, we have the following params:

```yaml
hideInSidebar: true
```

If `true`, the page will not be shown in the sidebar. It can be used in regular documentation and section pages (_index.md).

### Learn

The Learn portal (`/learn/`) groups four resources: Guides, Tutorials & Examples, Courses, and Technical Articles, with a link to videos on YouTube. The sidebar for `partition: learn` pages is built by `themes/qdrant-2024/layouts/partials/documentation/learn-menu.html` from the content below.

Search on `partition: learn` pages covers Articles, Courses, guide sections, and pages marked `learning_kind: tutorials`. The `learn-search-sections` meta tag supplies those paths because tutorials retain their Develop or Ecosystem partitions. Develop and Deploy continue to share the `develop,deploy,cloud,qdrant` documentation search scope.

The Guides and Tutorials & Examples hubs show the three most recently published dated pages in their collections. Set `date` (or `publishDate`) in a page's front matter to include it; undated pages remain in the full listings. Content moves do not reset publication dates. The initial three tutorial dates come from their original addition commits.

#### Guides

To add a guide, copy an existing guide into a new Markdown file in the appropriate topic directory. Use a descriptive, hyphenated filename, such as `my-guide.md`, and set `draft: true` while writing. Remove copied `aliases` and any metadata specific to the original guide, such as `guide_series` for a standalone guide.

Choose the directory that matches the guide:

| Topic | Directory under `content/documentation/` |
| --- | --- |
| Search Evaluation | `search-quality/` |
| Search Patterns | `search-patterns/` |
| Search Tuning | `search-tuning/` |
| Production & Performance | `production-patterns/` |

1. Fill in the title, `short_description` (card summary), `description` (search/social summary), and Markdown body. Keep the guide directly inside its topic directory.
2. Set `date` to the publication date, remove or update any copied `publishDate`, and choose a unique positive `weight` within the topic. Lower weights appear first; gaps such as 10, 20, 30 make later insertions easier.
3. Preview with the existing Hugo development server. Drafts require the server's `--buildDrafts` / `-D` option. Set `draft: false` when the guide is ready for publication, then submit the normal content PR.

The topic's `_index.md` cascades `partition: learn` and `learning_kind: guides` to its pages; do not repeat these fields in individual guides. No menu, catalog, or template edits are needed for a new guide in an existing topic:

- **Browse Guides by Topic**, the **topic landing page**, and the **Learn sidebar** list the topic's published pages by `weight`. `hideInSidebar: true` only hides the sidebar entry.
- **Recently Published** shows the three newest dated guides across all topics, sorted by Hugo's `PublishDate`: explicit `publishDate` takes precedence over `date`. Editing a guide or changing its weight does not make it recent. Undated guides remain in the full listings. Drafts and future publications are excluded from normal builds unless the corresponding Hugo build flags are enabled.
- **Markdown directories** are generated from the same topic pages.
- **Start with a Practical Guide** is curated in `content/documentation/guides-tab.md`. Each card references a guide by `page`; its title and URL come from that page, while its summary, icon, and button text remain customizable. Topic banner buttons are also curated.

Set `guide_series: true` only on pages that form an ordered series. The section's `guide_series_title` names the series, and `weight` sets the order of the numbered cards and the previous/next links. Standalone guides do not need this flag.

To add a new topic, copy an existing topic's `_index.md` into a new directory under `content/documentation/`. Update its title, descriptions, weight, icon, banner links, and `guide-cards` section path. Retain `partition: learn`, `learning_kind: guides`, their `cascade` defaults, and `layout: guides`. The overview and sidebar discover the new topic automatically; `layout: guides` also generates its Markdown directory.

When moving an existing page into a guide topic, preserve its original date, add its former URL to `aliases`, add an explicit redirect for its former `index.md` URL in `static/_redirects`, and update internal links. Hugo aliases only generate HTML redirects.

#### Tutorials & Examples

`/learn/examples/` automatically lists published pages marked `learning_kind: tutorials`, ordered by title. The existing `tutorials-*` sections and `documentation/examples/` supply that marker through their `_index.md` cascade. Pages retain their original URLs and Develop or Ecosystem navigation.

To add a tutorial:

1. Create a Markdown page in the appropriate tutorial section, or copy an existing tutorial and remove its old aliases and publication dates. Use `draft: true` while writing.
2. Fill in `title`, `short_description` (or `description`), `goal`, and `stack`. Reuse an existing goal where appropriate. Add optional `keywords` for collection search and `example_resources` for direct code or notebook links.
3. Set `date` (or `publishDate`) to the publication date and preview with the existing Hugo server (`--buildDrafts` / `-D` includes drafts). Set `draft: false` when ready and submit the normal content PR.

```yaml
goal: Search Quality
stack:
  - Python
  - FastEmbed
# Optional; each URL must also appear in the tutorial body.
example_resources:
  - label: Open Notebook
    url: https://github.com/qdrant/examples/blob/master/code-search/code-search.ipynb
```

No separate catalog entry is needed. The listing, Goal and Stack filters, Learn sidebar categories, Learn search scope, and Markdown directory all use the same discovered pages. Recently Published selects the three newest dated tutorials by `PublishDate`; editing a tutorial does not change its publication date. Normal builds exclude drafts and future publications.

A tutorial outside these sections can opt in by setting `learning_kind: tutorials` in its front matter. A non-tutorial inside them can opt out with `learning_kind: reference`. Keep `hideInSidebar` for controlling the documentation sidebar; it does not exclude a tutorial from Learn.

The build reports missing goals, stacks, or descriptions, and resource URLs that no longer appear in the tutorial body. `example_resources` is separate from Hugo's reserved `resources` field for page bundle configuration.

#### Articles

An article is listed under the category page in `content/articles/<category>/_index.md` that matches its `category`. The shared article-selection helper lives in `layouts/partials/documentation/articles/list.html`, so HTML and Markdown use the same collection. Existing categories and articles remain published; editorial reorganization and retirement are separate from the Guides migration.

## Blog

To add a new blog post, run the following commands:

``` bash
cd qdrant-landing
hugo new --kind blog-post blog/<post-title>.md
```

You'll see a file named `content/blog/<post-title>.md`. Open it and edit the front matter.

### Images

Store images for blog posts in the following subdirectory: `static/blog/<post-title>`. You can add nested directories if needed. For social media previews, use images of at least 1200x600px.

In the blog post file, you'll see:

- `preview_image`: The image that appears with the blog post. If you want different images for social media, the blog post title, or the preview, use the following properties:

  - `social_preview_image`
  - `title_preview_image`
  - `small_preview_image`

- 

### Important notes

- Add tags. While they're not shown on the blog post page, they are used to display related posts.
- If a post has `featured: true` property in the front matter this post will appear in the "Features and News" blog section. Only the last 4 featured posts will be displayed in this section. Featured posts will not appear in the regular post list.
  - If there are more than 4 `featured: true` posts (where `draft: false`), the oldest post disappears from /blog.

## Agenda

Agenda pages display event schedules with talk slots, speaker info, and break cards. Each agenda is a single markdown file containing all slots in the front matter — no separate files per talk.

To create a new agenda page:

```bash
cd qdrant-landing
hugo new --kind agenda agenda/my-event.md
```

This generates `content/agenda/my-event.md` with a starter template. Open it and fill in the front matter:

- `heading` — page title displayed on the page
- `logo` — path to the event logo shown next to the heading
- `hero_image` — hero background image at the top
- `badge_icons_path` — directory path for badge SVG icons (used by the `svg` partial)
- `description` — SEO meta description
- `subtitle` — visible text below the heading
- `date_info`, `location` — event date and venue

Each item in the `slots` list is either a **talk** or a **break**:

```yaml
slots:
  # Talk slot
  - type: talk
    title: "Talk Title"
    description: "Talk description text."
    company_logo: /img/path-to/logo.svg
    badge: "BADGE NAME"
    badge_type: qdrant       # qdrant | search | agents | edge
    badge_icon: presentation # matches SVG filename in badge_icons_path
    speaker_name: "Speaker Name"
    speaker_role: "Role, Company"
    speaker_avatar: /img/path-to/avatar.png
    duration: "20'"
    time: "10:00 AM"

  # Break slot
  - type: break
    title: "Coffee Break"
    duration: "15'"
    time: "10:30 AM"
```

Optional talk parameters:
- `company_logo_offset` — adjust logo position with `placement` (top/bottom/left/right) and `value` (px)

The layout lives at `themes/qdrant-2024/layouts/agenda/single.html` and styles at `themes/qdrant-2024/assets/css/partials/_agenda.scss`.

## Demo

Demos and filters for the `/demo` page live in `qdrant-landing/content/demo/items/_index.md`. Edit that file only — no template changes needed for new demos or filters.

### Add a demo

Append an entry under `demos:`:

```yaml
demos:
  - id: my-new-demo          # unique slug
    title: My New Demo
    description: Short description shown on the card.
    category: Semantic Search  # must match a filter field (see below)
    image: /img/demos/demo-0.png  # optional; omit for a placeholder
    github: https://github.com/org/repo  # optional; icon link on the card
    weight: 10                 # optional; same rules as Hugo page weight
    link:
      text: View Demo
      url: https://example.com/
```

`weight` follows Hugo’s built-in page weight rules: use a non-zero integer; lighter items float to the top, heavier sink to the bottom; missing or `0` weight is placed at the end. Ties break by title.

Put card images in `themes/qdrant-2024/static/img/demos/`. Provide a PNG and a matching WebP at **800×296px** (same basename, e.g. `demo-0.png` + `demo-0.webp`). Only list the PNG file in the markdown; the picture partial swaps the extension to serve WebP when available.

### Add a filter

Each filter needs a `key` that matches a field on every demo, and a `label` for the sidebar. Filter options are collected automatically from demo values unless you set `values` explicitly.

```yaml
filters:
  - key: category
    label: Categories
  - key: industry          # new filter
    label: Industries

demos:
  - id: my-new-demo
    title: My New Demo
    description: Short description shown on the card.
    category: Semantic Search
    industry: Healthcare   # same key as the new filter
    link:
      text: View Demo
      url: https://example.com/
```

Optional: `batchSize` controls how many cards show before “View More” (default `8`).

## Shortcodes 🧩🧩🧩

Hugo lets you use built-in and custom shortcodes to simplify the creation of content. Meanwhile, **keep in mind that shortcodes make the content less portable**. If you decide to move the content to another platform, you'll need to rewrite the shortcodes. **Avoid to overuse them.**

You can use shortcodes in markdown files by enclosing the shortcode in double curly braces. For example:

```markdown
{{< shortcode-name param1="value1" param2="value2" >}}
```

### Built-in shortcodes

List of built-in shortcodes can be found in the [Hugo documentation](https://gohugo.io/content-management/shortcodes/).

If you use a shortcode in your markdown file, but it fails to render, check if the shortcode is available with the Hugo version the site is built with.

### Custom shortcodes

You can find the list of available shortcodes in the `qdrant-landing/themes/qdrant/layouts/shortcodes` directory.

#### 🧩 Card
- Card - variant 1

  ![](readme-assets/shortcode-card-1.png)

Example:
```
{{< card
title="Qdrant Quickstart"  
link="/documentation"  
type="Info"  // optional
icon="/icons/outline/documentation-blue.svg" 
col="6" >}}
  This guide will help you get started with Qdrant locally.  
{{< /card >}}
```

- Card - variant 2

  ![](readme-assets/shortcode-card-2.png)

Example:
```
{{< card
title="Qdrant Quickstart"  
link="/documentation"  
image="/img/brand-resources-hero.svg"  
col="6" >}}
  This guide will help you get started with Qdrant locally.  
{{< /card >}}
```

Parameters for card shortcode:
- `title` - required
- `link` -required
- `image` - optional, default null
- `type` - optional, default "Document"
- `icon` - optional, default is an icon of documents
- `col` - optional, default 12

Card variant 1 is the default; you can optionally change the icon and type, if you use `image` option, you will get variant 2, type and icon will be ignored even if given.

<hr>

#### 🧩 Grid Row

Cards should be enclosed in a row shortcode if you want to have more than one card in a row.

Example:
```
{{< grid-row >}}
  {{< card
    title="Title one"  
    link="/some-link"  
    image="some-image.svg"  
    col="6" >}}
      This is a first card.  
  {{< /card >}}
  {{< card  
    title="Title two"  
    link="/another-link"  
    image="another-image.svg"  
    col="6" >}}
      This is a second card.
  {{< /card >}}
{{< /grid-row >}}
```

Each card will take up half of the row in the example above.

<hr>

#### 🧩 Banner

![](readme-assets/shortcode-banner.png)

Example:
```
{{< banner link="/documentation" >}}  
  This guide will help you get started with Qdrant locally.  
{{< /banner >}}
```

Parameters for banner shortcode:
- `link` - required
- `cta` - optional, default "Get Started"
- `image` - optional, default "/img/rocket.svg"

<hr>

#### 🧩 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"

<hr>

#### 🧩 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"

<hr>

#### 🧩 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

<hr>

#### 🧩 Date

![](readme-assets/shortcode-date.png)

Example:
```
{{< date >}} Day 1 {{< /date >}}
```

Parameters for date shortcode:
- `image` - optional, default "/icons/outline/date-blue.svg"

<hr>

#### 🧩 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 >}}
```

<hr>

#### 🧩 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 >}}
```

<hr>

#### 🧩 Code Snippets Widget

![](readme-assets/shortcode-snippets.png)

This shortcode renders a code snippets widget from a specified path.
Use it when you want to manage code examples as a collection of separate Markdown files. The following parapghs refer to hand-written snippets. It's recommended to write code snippets as testable code instead. Refer to [automation/snippets/README.md](automation/snippets/README.md) for details.

##### 📁 Directory Structure
Place all code snippets for a single widget into one directory. Each file should be named after the programming language it represents:

```
points-id/
├── http.md
├── python.md
├── go.md
```
File names are used for sorting. It's recommended to name files according to the language they contain (e.g., python.md, go.md). Sorting is controlled by the order parameter or the snippetsOrder parameter (see below).

Each file should contain a code snippet in a fenced code block (```).

##### ▶️ Example Usage
``` hugo
{{< code-snippet path="/documentation/headless/snippets/points-id/" order="python http go" >}}
``` 

##### ⚙️ Parameters
- `path` (required) – Path to the directory (inside content/) containing the snippet files.
- `order` (optional) – Space-separated list of snippet names to display first. Remaining files will be rendered in the order they appear in the directory. Sorting is based on file names (without .md).

You can also define a global default snippet order using the snippetsOrder parameter in the relevant section’s _index.md.

##### ⚠️ Notes
**Important:** Turn off rendering for the snippets directory if it's not already disabled in its parent section. Otherwise, Hugo will attempt to generate standalone pages for these files.

You can include multiple snippets in a single Markdown file, but in that case, the order parameter has no effect—they will render in the order they appear in the file.

##### 🚫 Limitations
Snippet files must not contain front matter (---). Each code snippet should be a fenced code block (```).

The snippetsOrder parameter only works at the section level or deeper. If you're adding snippets to a section for the first time, make sure to define snippetsOrder in that section’s or a child section’s _index.md.


## SEO

### Structured data (Schema.org, JSON-LD)

Structured data is a standardized format for providing information about a page and classifying the page content. It is used by search engines to understand the content of the page and to display rich snippets in search results.

We use JSON-LD format for structured data. Data is stored in JSON files in the `/assets/schema` directory. If no specific schema is provided for a page, the default schema is used based on the page type as defined in the `qdrant-landing/themes/qdrant/layouts/partials/seo_schema.html` file.

To add schema to a specific page, use the `seo_schema` or `seo_schema_json` parameter in the front matter of content markdown files (directory `content`).

To add JSON directly to the page, use the `seo_schema` parameter. The value should be a JSON object.

Example:

```yaml
seo_schema: {
    "@context": "https://schema.org",
    "@type": "Organization",
    "name": "Qdrant",
    "url": "https://qdrant.io",
    "logo": "https://qdrant.io/images/logo.png",
    "sameAs": [
      "https://www.linkedin.com/company/qdrant",
      "https://twitter.com/qdrant"
    ]
  }
```

To add a path to a JSON file with schema data, use the `seo_schema_json` parameter. This parameter should contain a list of paths to JSON files.
The path should be relative to the `qdrant-landing/assets` directory.

Example:

```yaml
seo_schema_json:
  - schema/schema-organization.json
  - schema/product-schema.json
```

If you want to add a new schema, create a new JSON file in the `qdrant-landing/assets/schema` directory and add the path to the `seo_schema_json` parameter.

When use `seo_schema` and `seo_schema_json` together, `seo_schema` will be used additionally to `seo_schema_json` adding the second <script> tag with the `seo_schema` value.

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)