Module

cache.indexes.category_index

Category Index - Index pages by category.

View source
1 Class

Classes

CategoryIndex
Index pages by category (single-valued taxonomy). Unlike tags (multi-valued), categories are typic…
2

Index pages by category (single-valued taxonomy).

Unlike tags (multi-valued), categories are typically single-valued: category: tutorial category: api-reference category: guide

Provides O(1) lookup: site.indexes.category.get('tutorial') # All tutorials site.indexes.category.get('api-reference') # All API docs

Common patterns:

  • Documentation: 'tutorial', 'guide', 'reference', 'howto'
  • Blog: 'tech', 'business', 'personal'
  • Recipes: 'appetizer', 'main-course', 'dessert'
Inherits from QueryIndex

Methods 1

extract_keys
Extract category from page metadata.
1 list[tuple[str, dic… 
def extract_keys(self, page: Page) -> list[tuple[str, dict[str, Any]]]

Extract category from page metadata.

Parameters 1
page Page
Returns

list[tuple[str, dict[str, Any]]]

Internal Methods 1
__init__
1 None 
def __init__(self, cache_path: Path)
Parameters 1
cache_path Path