Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Index Settings

The [index] section controls which files are indexed.

Configuration

[index]
include = [
    "**/*.rs",
    "**/*.ts",
    "**/*.tsx",
    "**/*.js",
    "**/*.jsx",
    "**/*.py",
    "**/*.go",
    "**/*.md",
]

exclude = [
    "**/node_modules/**",
    "**/target/**",
    "**/dist/**",
    "**/.git/**",
    "**/build/**",
    "**/__pycache__/**",
]

use_gitignore = true

Options

KeyTypeDefaultDescription
includestring[]See aboveGlob patterns for files to include
excludestring[]See aboveAdditional exclusion patterns (on top of .gitignore)
use_gitignorebooltrueWhether to respect .gitignore files

Notes

  • Include patterns determine which file extensions are parsed and indexed. Add patterns to index additional file types.
  • Exclude patterns are applied in addition to .gitignore. Use them to skip generated code, vendor directories, or other non-useful content.
  • When use_gitignore is true, files matched by .gitignore are automatically excluded even if they match an include pattern.