diff --git a/README.md b/README.md index e9051b0fb..9899f2c59 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,44 @@ +# 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) + - [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 @@ -271,7 +312,7 @@ In the blog post file, you'll see: - 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. -## Shortcodes +## 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.** @@ -291,7 +332,7 @@ If you use a shortcode in your markdown file, but it fails to render, check if t You can find the list of available shortcodes in the `qdrant-landing/themes/qdrant/layouts/shortcodes` directory. -#### Card +#### 🧩 Card - Card - variant 1  @@ -323,7 +364,7 @@ col="6" >}} {{< /card >}} ``` -Options for card shortcode: +Parameters for card shortcode: - `title` - required - `link` -required - `image` - optional, default null @@ -333,7 +374,9 @@ Options for card shortcode: 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. -#### Grid Row +