https://github.com/atsphinx/pagefind

https://github.com/atsphinx/pagefind

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/atsphinx/pagefind
• Owner: atsphinx
• License: apache-2.0
• Created: 2025-03-07T15:14:43.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-14T19:11:40.000Z (over 1 year ago)
• Last Synced: 2025-03-14T20:23:16.601Z (over 1 year ago)
• Language: Python
• Size: 65.4 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
=================

atsphinx-pagefind

=================

Pagefind search component for Sphinx.

Overview

========

This is Sphinx extension to use Pagefind for searching documentation.

Pagefind is website search library for static site.It can indexes from published website.

Please see `official website `_ if you want to know more information.

You can see `own document `_ to know behavior of this.

Getting started

===============

Installation

------------

This publishes on PyPI. You can install by ``pip`` and other package managers.

.. code:: console

   pip install atsphinx-pagefind

Configuration

-------------

Register this into your ``conf.py`` of document.

.. code:: python

   extensions = [

       ...,  # Your extensions

       "atsphinx.pagefind",

   ]