semvec/pypi-packages huggingface dataset:
readthedocs-sphinx-search 0.3.2
Sphinx extension to enable search as you type for docs hosted on Read the Docs.
License: MIT
Requires Python: >=3.6
Keywords: sphinx search readthedocs

readthedocs-sphinx-search - Search as you type for Read the Docs
================================================================

|pypi| |docs| |license| |build-status|

``readthedocs-sphinx-search`` is a `Sphinx`_ extension to enable *search as you type* for docs hosted on `Read the Docs`_.
Try it at https://readthedocs-sphinx-search.readthedocs.io/en/latest/?rtd_search=testing.

.. _Sphinx: https://www.sphinx-doc.org/
.. _Read the Docs: https://readthedocs.org/

Installation
------------

.. code-block:: bash

   pip install readthedocs-sphinx-search


Configuration
-------------

Add this extension in your ``conf.py`` file as:

.. code-block:: python

   extensions = [
    # ... other extensions here
    'sphinx_search.extension',
   ]


.. |docs| image:: https://readthedocs.org/projects/readthedocs-sphinx-search/badge/?version=latest
   :alt: Documentation Status
   :target: https://readthedocs-sphinx-search.readthedocs.io/en/latest/?badge=latest

.. |license| image:: https://img.shields.io/github/license/readthedocs/readthedocs-sphinx-search.svg
   :target: LICENSE
   :alt: Repository license

.. |build-status| image:: https://circleci.com/gh/readthedocs/readthedocs-sphinx-search.svg?style=svg
   :alt: Build status
   :target: https://circleci.com/gh/readthedocs/readthedocs-sphinx-search


.. |pypi| image:: https://img.shields.io/pypi/v/readthedocs-sphinx-search.svg
   :target: https://pypi.python.org/pypi/readthedocs-sphinx-search
   :alt: PyPI Version
md-format-hook 0.0.5
Adds reasonable spaces between Chinese and English and corrects the case of special nouns.
License: MIT
Requires Python: >=3.8

# md-format
A pre-commit hook that formats .md files. It automatically adds reasonable spaces between Chinese and English and corrects the case of special nouns.

For pre-commit: see https://github.com/pre-commit/pre-commit

## Using md-format with pre-commit
Add this to your `.pre-commit-config.yaml` :

```yaml
- repo: https://github.com/PKUcoldkeyboard/md-format
  rev: 0.0.5
  hooks:
  - id: md-format
```