Metadata-Version: 2.5
Name: mkdocs-pixel-lab
Version: 0.1.0rc1
Summary: A vibrant, accessible MkDocs documentation theme by Trained-by-Humans.
Project-URL: Homepage, https://github.com/trained-by-humans/mkdocs-pixel-lab
Project-URL: Documentation, https://github.com/trained-by-humans/mkdocs-pixel-lab#readme
Project-URL: Repository, https://github.com/trained-by-humans/mkdocs-pixel-lab
Project-URL: Issues, https://github.com/trained-by-humans/mkdocs-pixel-lab/issues
Project-URL: Changelog, https://github.com/trained-by-humans/mkdocs-pixel-lab/releases
Author: Trained-by-Humans
License-Expression: Apache-2.0
License-File: LICENSE
License-File: THIRD_PARTY_LICENSES.md
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: MkDocs
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Requires-Dist: mkdocs<2,>=1.6
Requires-Dist: pymdown-extensions<11,>=10
Provides-Extra: test
Requires-Dist: pytest-playwright>=0.7; extra == 'test'
Requires-Dist: pytest>=8; extra == 'test'
Description-Content-Type: text/markdown

# Pixel Lab

Pixel Lab is a vibrant, accessible theme for [MkDocs](https://www.mkdocs.org/).

## Quick start

```bash
python -m pip install mkdocs-pixel-lab
```

Use it in `mkdocs.yml`:

```yaml
theme:
  name: pixel-lab
```

Pixel Lab includes responsive navigation, search, code-copy controls, heading
fragment tracking, a skip link, and styling for standard MkDocs and Pymdown
content.

## Preview

<table>
  <tr>
    <td align="center"><img src="tests/snapshots/desktop.png" alt="Pixel Lab desktop documentation preview" height="480"></td>
    <td align="center"><img src="tests/snapshots/mobile.png" alt="Pixel Lab mobile documentation preview" height="480"></td>
  </tr>
  <tr>
    <td align="center">Desktop</td>
    <td align="center">Mobile</td>
  </tr>
</table>

## Development

```bash
python -m pip install -e '.[test]'
playwright install chromium
pytest
```
