Skip to main content

Create a Document

Documents are groups of pages connected through:

  • a sidebar
  • previous/next navigation
  • versioning

Create your first Doc​

Create a Markdown file at docs/internal/hello.md:

docs/internal/hello.md
# Hello

This is my **first Docusaurus document**!

A new document is now available at http://localhost:3000/docs/hello.

Configure the Sidebar​

Docusaurus automatically creates a sidebar from the docs folder.

Add metadata to customize the sidebar label and position:

docs/internal/hello.md
---
# Sidebar
sidebar_position: 3

# Metadata
title: Guide
description: How to integrate a new project
tags: [integration, setup, onboarding]

# Visibility
# draft documents will only be available during development.
draft: true
# Unlisted documents will be available in both development and production.
# They will be "hidden" in production, not indexed, excluded from sitemaps, and can only be accessed by users having a direct link.
unlisted: true
---

# Hello

This is my **first Docusaurus document**!

It is also possible to create your sidebar explicitly in sidebars/<name-of-the-sidebar>.ts:

sidebars/sidebarInternalDocs.ts
export default {
    tutorialSidebar: [
        "intro",
        "hello",
        {
            type: "category",
            label: "Tutorial",
            items: ["tutorial-basics/create-a-document"],
        },
    ],
};

The site uses offline full-text search powered by @cmfcmf/docusaurus-search-local. The search index is generated at build time from the rendered page content.

How ranking works​

The search plugin weights matches differently depending on where they appear:

LocationBoostWhat it means
Page title5xStrongest signal — choose titles carefully
Tags3xAdd relevant keywords as tags
Body content1xStandard weight

Tips for authors​

  • Use descriptive titles. The title frontmatter field has the highest search weight.
  • Add tags. Use the tags frontmatter field to add keywords that readers might search for but that don't appear in the page content.
  • keywords has no effect on search. The Docusaurus keywords field only generates HTML <meta> tags for external search engines — the local search plugin ignores it.