Metadata-Version: 2.4
Name: mkdocs-cwd
Version: 0.1.4
Summary: A clean, modern MkDocs theme built with TailwindCSS and Doom One dark mode
Author-email: dmth <dmitry@falsetrue.io>
License: MIT
Project-URL: Homepage, https://github.com/catwatchdog/mkdocs-cwd
Project-URL: Repository, https://github.com/catwatchdog/mkdocs-cwd
Keywords: mkdocs,theme,tailwindcss,documentation,doom
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs>=1.5
Dynamic: license-file

# mkdocs-cwd

A clean, modern MkDocs theme built with TailwindCSS. Features a Doom One dark mode, full-text search, responsive layout, and BEM-structured CSS.

## Features

- **TailwindCSS** via Play CDN with custom color palette
- **Doom One dark mode** — toggle with button, respects system preference, persisted in localStorage
- **Full-text search** — lunr.js powered, `Ctrl+K` / `Cmd+K` shortcut, keyboard navigation, highlighted snippets
- **Responsive** — collapsible sidebar on mobile, three-column layout on desktop (sidebar / content / table of contents)
- **Table of contents** — right sidebar with scroll-spy highlighting
- **Prev / Next navigation** between pages
- **Syntax highlighting** — highlight.js with GitHub Light / Atom One Dark themes
- **Inter + JetBrains Mono** fonts
- **BEM-structured CSS** — all styles use Block Element Modifier naming, no inline utility classes

## Installation

```bash
pip install mkdocs-cwd
```

## Usage

Set the theme in your `mkdocs.yml`:

```yaml
site_name: My Docs
theme:
  name: cwd

plugins:
  - search
```

The `search` plugin is required for the search modal to work.

## Dark mode

Dark mode uses the [Doom One](https://github.com/doomemacs/themes) color palette from Doom Emacs. It toggles via:

- The moon/sun button in the header
- System preference (`prefers-color-scheme: dark`)
- Persisted in `localStorage` across sessions

### Color reference

| Role             | Light            | Dark (Doom One)  |
|------------------|------------------|------------------|
| Background       | `#ffffff`        | `#282c34`        |
| Elevated surface | `#f8fafc`        | `#23272e`        |
| Border           | `#e2e8f0`        | `#3f444a`        |
| Body text        | `#475569`        | `#bbc2cf`        |
| Muted text       | `#94a3b8`        | `#5B6268`        |
| Headings         | `#0f172a`        | `#DFDFDF`        |
| Links            | `#4f46e5`        | `#51afef`        |
| Inline code      | `#4338ca`        | `#4db5bd`        |
| Highlights       | `#e0e7ff`        | `#ECBE7B`        |

## Customization

Override any template by creating a `custom_dir` alongside the theme:

```yaml
theme:
  name: cwd
  custom_dir: overrides/
```

Then place partial templates in `overrides/` to extend or replace blocks.

## Development

```bash
git clone https://github.com/catwatchdog/mkdocs-cwd.git
cd mkdocs-cwd
pip install -e .
```

## Screenshot

![mkdocs-cwd screenshot.jpeg](https://github.com/catwatchdog/mkdocs-cwd/blob/master/screenshot.jpeg?raw=true)

## License

MIT
