mkdocs-sorrow-theme 0.1.0__tar.gz

mkdocs_sorrow_theme-0.1.0/.gitignore

@@ -0,0 +1,4 @@
+site/
+.venv/
+dist/
+__pycache__/

mkdocs_sorrow_theme-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Muhamad Salman
+Copyright (c) 2024 Dracula Theme
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mkdocs_sorrow_theme-0.1.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.5
+Name: mkdocs-sorrow-theme
+Version: 0.1.0
+Summary: MkDocs theme in the Omarchy Sorrow palette
+Project-URL: Homepage, https://github.com/MHS-20/sorrow-mkdocs-theme
+Project-URL: Repository, https://github.com/MHS-20/sorrow-mkdocs-theme
+Project-URL: Issues, https://github.com/MHS-20/sorrow-mkdocs-theme/issues
+License-Expression: MIT
+License-File: LICENSE
+Keywords: dark,mkdocs,mkdocs-theme,omarchy,sorrow,theme
+Classifier: Environment :: Web Environment
+Classifier: Framework :: MkDocs
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Text Processing :: Markup :: HTML
+Requires-Python: >=3.9
+Requires-Dist: mkdocs<2,>=1.6.1
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/MHS-20/sorrow-mkdocs-theme/main/assets/sorrow-title.png" alt="Sorrow" width="600">
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/mkdocs-sorrow-theme/"><img src="https://img.shields.io/pypi/v/mkdocs-sorrow-theme" alt="PyPI version"></a>
+</p>
+
+# mkdocs-sorrow-theme
+
+An MkDocs theme in the palette inspired from Omarchy **Solitude** theme. It is based on
+the [Dracula theme for MkDocs](https://github.com/dracula/mkdocs): it keeps
+Dracula's layout and replaces its colors and code highlighting.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/MHS-20/sorrow-mkdocs-theme/main/assets/screenshot.png" alt="Sorrow theme screenshot" width="800">
+</p>
+
+## Install
+
+```sh
+pip install mkdocs-sorrow-theme
+```
+
+Then, in `mkdocs.yml`:
+
+```yaml
+theme:
+  name: sorrow
+  favicon: assets/favicon.ico  # optional; defaults to the Sorrow icon
+  logo: assets/logo.png        # optional sidebar logo
+```
+
+`highlightjs` (default `true`) and `hljs_languages` control highlight.js.
+There is no footer and no option to load other highlight styles.
+
+## How it works
+
+The Dracula templates and layout assets are copied into this package rather
+than inherited with `extends: dracula`, because MkDocs copies every file of a
+parent theme into the built site. Copying lets the theme leave out Dracula's
+highlight stylesheet, logo, favicon, footer and color tokens.
+
+- `base.html` and `modules/`: Dracula's templates. The sidebar divider uses
+  the sidebar color, the favicon defaults to the Sorrow icon, and
+  the footer is removed. CSS classes use the prefix `sorrow-` instead of
+  `drac-`.
+- `assets/css/sorrow-ui.css`, `assets/css/mkdocs.min.css`: Dracula's
+  stylesheets without its color tokens; admonition tints read the tokens.
+- `assets/css/sorrow.css`: the color tokens.
+- `assets/css/sorrow-highlight.css`: highlight.js colors following Omarchy's
+  syntax mapping (`default/themed/helix.toml.tpl`).
+
+## Palette
+
+| Token | Sorrow key | Color |
+| --- | --- | --- |
+| `--black` (sidebar, code) | `dark_background` | `#0c0e10` |
+| `--blackSecondary` (page) | `background` | `#101315` |
+| `--greyTernary` (text) | `foreground` | `#cacccc` |
+| `--white` | `yellow` | `#d9dbdc` |
+| `--grey` | `selection` | `#3d1621` |
+| `--greySecondary` | `muted` | `#4b4e55` |
+| `--purple` | `accent` | `#7a1a2c` |
+| `--cyan` | `cyan` | `#943a4c` |
+| `--green` | `green` | `#9fa5a9` |
+| `--orange` | `bright_yellow` | `#c9c2b4` |
+| `--pink` | `magenta` | `#a8495b` |
+| `--red` | `bright_red` | `#a82a3c` |
+| `--yellow` | `yellow` | `#d9dbdc` |
+
+The four reds are darker than the Sorrow originals. Lighter and translucent
+variants are derived with `color-mix()`.
+
+## Develop
+
+```sh
+uv venv && uv pip install -e .
+uv run mkdocs serve
+```
+
+## Credits
+
+Released under the MIT License. Built on the MIT-licensed [Dracula theme for MkDocs](https://github.com/dracula/mkdocs).

mkdocs_sorrow_theme-0.1.0/README.md

@@ -0,0 +1,84 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/MHS-20/sorrow-mkdocs-theme/main/assets/sorrow-title.png" alt="Sorrow" width="600">
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/mkdocs-sorrow-theme/"><img src="https://img.shields.io/pypi/v/mkdocs-sorrow-theme" alt="PyPI version"></a>
+</p>
+
+# mkdocs-sorrow-theme
+
+An MkDocs theme in the palette inspired from Omarchy **Solitude** theme. It is based on
+the [Dracula theme for MkDocs](https://github.com/dracula/mkdocs): it keeps
+Dracula's layout and replaces its colors and code highlighting.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/MHS-20/sorrow-mkdocs-theme/main/assets/screenshot.png" alt="Sorrow theme screenshot" width="800">
+</p>
+
+## Install
+
+```sh
+pip install mkdocs-sorrow-theme
+```
+
+Then, in `mkdocs.yml`:
+
+```yaml
+theme:
+  name: sorrow
+  favicon: assets/favicon.ico  # optional; defaults to the Sorrow icon
+  logo: assets/logo.png        # optional sidebar logo
+```
+
+`highlightjs` (default `true`) and `hljs_languages` control highlight.js.
+There is no footer and no option to load other highlight styles.
+
+## How it works
+
+The Dracula templates and layout assets are copied into this package rather
+than inherited with `extends: dracula`, because MkDocs copies every file of a
+parent theme into the built site. Copying lets the theme leave out Dracula's
+highlight stylesheet, logo, favicon, footer and color tokens.
+
+- `base.html` and `modules/`: Dracula's templates. The sidebar divider uses
+  the sidebar color, the favicon defaults to the Sorrow icon, and
+  the footer is removed. CSS classes use the prefix `sorrow-` instead of
+  `drac-`.
+- `assets/css/sorrow-ui.css`, `assets/css/mkdocs.min.css`: Dracula's
+  stylesheets without its color tokens; admonition tints read the tokens.
+- `assets/css/sorrow.css`: the color tokens.
+- `assets/css/sorrow-highlight.css`: highlight.js colors following Omarchy's
+  syntax mapping (`default/themed/helix.toml.tpl`).
+
+## Palette
+
+| Token | Sorrow key | Color |
+| --- | --- | --- |
+| `--black` (sidebar, code) | `dark_background` | `#0c0e10` |
+| `--blackSecondary` (page) | `background` | `#101315` |
+| `--greyTernary` (text) | `foreground` | `#cacccc` |
+| `--white` | `yellow` | `#d9dbdc` |
+| `--grey` | `selection` | `#3d1621` |
+| `--greySecondary` | `muted` | `#4b4e55` |
+| `--purple` | `accent` | `#7a1a2c` |
+| `--cyan` | `cyan` | `#943a4c` |
+| `--green` | `green` | `#9fa5a9` |
+| `--orange` | `bright_yellow` | `#c9c2b4` |
+| `--pink` | `magenta` | `#a8495b` |
+| `--red` | `bright_red` | `#a82a3c` |
+| `--yellow` | `yellow` | `#d9dbdc` |
+
+The four reds are darker than the Sorrow originals. Lighter and translucent
+variants are derived with `color-mix()`.
+
+## Develop
+
+```sh
+uv venv && uv pip install -e .
+uv run mkdocs serve
+```
+
+## Credits
+
+Released under the MIT License. Built on the MIT-licensed [Dracula theme for MkDocs](https://github.com/dracula/mkdocs).

mkdocs_sorrow_theme-0.1.0/mkdocs_sorrow_theme/404.html

@@ -0,0 +1,12 @@
+{% extends "base.html" %}
+
+{% block content %}
+    <section class="p-md-5 section-content">
+        <article>
+            <p></p>
+            <h1>404</h1>
+            <hr>
+            <p><strong>Page not found</strong></p>
+        </article>
+    </section>
+{% endblock %}