mirror of
https://github.com/qdrant/landing_page.git
synced 2026-09-27 15:08:30 +02:00
treanandAndrey Vasnetsov
092697f71e
* added social previews and command to the preview generating script * upd preview Co-authored-by: Andrey Vasnetsov <andrey@vasnetsov.com>
85 lines
3.7 KiB
Markdown
85 lines
3.7 KiB
Markdown
To rebuild scss to css:
|
||
|
||
```bash
|
||
npm install
|
||
```
|
||
|
||
# Build css from scss
|
||
|
||
Install sass if you don't have it:
|
||
|
||
```bash
|
||
npm install -g sass
|
||
```
|
||
|
||
``` bash
|
||
cd qdrant-landing
|
||
sass --watch --style=compressed ./qdrant-landing/themes/qdrant/static/css/main.scss ./qdrant-landing/themes/qdrant/static/css/main.css
|
||
```
|
||
|
||
# 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
|
||
---
|
||
```
|
||
|
||
## 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
|
||
```
|
||
|
||
### Prepare preview image
|
||
|
||
For the preview use image with the aspect ratio 3 to 1 in jpg or png format. With resolution not smaller than 1200x630px. The image should illustrate in some way the article's core idea. Fill free got creative. Check out that 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 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 filtrable-hnsw
|
||
```
|
||
|
||
This command will create a directory `preview` in `static/article_data/filtrable-hnsw` and generate preview images in it. If the directory `static/article_data/filtrable-hnsw` doesn't exist, it will be created. If it exists, only files in children `preview` directory will be affected. In this case preview images will be overwritten. Your original image will not be affected.
|
||
|
||
### 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) |