Skip to main content

Page Configuration

Each documentation page on the Hasbara platform uses YAML frontmatter at the top of the Markdown file to define key settings for the page. This frontmatter controls how the page is displayed, organized, and described in the system.

Here’s an overview of the common configuration options:

title​

Description: The title of the page, displayed in the sidebar and at the top of the document.

title: How To Add Pages?

description​

Description: A short summary of the page’s content, often used in search results or tooltips.

description: A guide on how to add pages to the Hasbara documentation.

Description: Determines the order in which the page appears in the sidebar within its folder. Lower numbers appear first.

sidebar_position: 5

slug (Optional)​

Description: Custom URL path for the page. Use this if you want to override the default path based on the file name.

slug: /custom/path/to/page

hide_title (Optional)​

Description: Hides the title at the top of the page if set to true. This is useful when the title is already included in the page body.

hide_title: true

hide_table_of_contents (Optional)​

Description: If set to true, hides the automatic table of contents generated for the page.

hide_table_of_contents: true

keywords (Optional)​

Description: Adds meta keywords for SEO or internal search optimization.

keywords: [markdown, guide, how-to]

image (Optional)​

Description: Specifies a preview image for the page when shared on social media.

image: /img/social-preview.png

Example Full Configuration​


title: How To Create a Folder?
description: Learn how to organize your documents by creating new folders.
sidebar_position: 6
slug: /docs/create-folder
hide_table_of_contents: false
keywords: [folders, organization, documentation]

This configuration appears at the very top of your .md file and should always be enclosed between triple dashes (---).

Using these options helps keep your documentation structured, easy to navigate, and SEO-friendly.