Metadata-Version: 2.4
Name: inkpress
Version: 0.1.0
Summary: Markdown typography engine for WeChat, Xiaohongshu and more — 25 themes, zero external dependencies, fully offline.
Author: inkpress contributors
License: MIT License
        
        Copyright (c) 2026 inkpress
        
        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.
        
Project-URL: Homepage, https://github.com/michellewkx/inkpress
Project-URL: Documentation, https://github.com/michellewkx/inkpress#readme
Project-URL: Repository, https://github.com/michellewkx/inkpress
Project-URL: Showcase, https://michellewkx.github.io/inkpress
Keywords: markdown,wechat,typography,themes,weixin,公众号,排版
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: markdown>=3.6
Requires-Dist: pygments>=2.17
Requires-Dist: pyyaml>=6.0
Provides-Extra: server
Requires-Dist: fastapi>=0.100; extra == "server"
Requires-Dist: uvicorn>=0.23; extra == "server"
Dynamic: license-file

<div align="center">

# ✒️ inkpress

**Typography engine for creators — 为创作者打造的排版引擎**

Markdown → WeChat / Xiaohongshu / More platforms

25 themes · Zero deps · Free forever

[🌐 Live Demo](http://michellewkx.com/inkpress/) · [📦 Install](#install) · [📖 Docs](#custom-themes--自定义主题)

</div>

---

## Features / 特性

- **25 curated themes** across 5 series — classic, oriental, magazine, social, and more
- **Zero dependencies** — pure Python core, no external API calls
- **Fully offline** — works anywhere, even without internet
- **WeChat optimized** — copy-paste directly into WeChat Official Account editor
- **Xiaohongshu ready** — formatted content for Xiaohongshu long posts (coming soon)
- **YAML themes** — fully customizable, create your own in minutes
- **JS renderer** — browser-based 1:1 mirror of the Python engine for live preview

---

## Install / 安装

```bash
pip install markdown pygments pyyaml
```

**CLI usage / 命令行使用：**

```bash
# Convert an article / 转换文章
python -m inkpress convert article.md -t aurora -o output.html

# List all themes / 查看所有主题
python -m inkpress themes

# Start local preview server / 启动本地预览
python -m inkpress serve
```

**Python API：**

```python
from inkpress import convert, list_themes

# One-liner / 一行搞定
html = convert("# Hello\nWorld", theme="aurora")

# Browse themes / 浏览主题
for name, desc in list_themes().items():
    print(f"{name}: {desc}")
```

---

## Theme Gallery / 主题画廊

5 series, 25 handcrafted themes — [browse them all online →](http://michellewkx.com/inkpress/)

5 大系列，25 个精品主题 — [在线预览 →](http://michellewkx.com/inkpress/)

| Series / 系列 | Themes / 主题 |
|------|------|
| **Classic / 经典** | default, minimal, mono, elegant-serif, aurora, ocean, sunset, latte, bluehl, corporate, forest, sunshine |
| **Oriental / 东方** | chinese-ink, zen-garden, tang-poetry, sanguo, inkwash |
| **Magazine / 杂志** | vogue, bauhaus, editorial, academy |
| **Social / 社交** | xiaohongshu, mint, mint-highlight, sakura |

---

## Custom Themes / 自定义主题

Drop a YAML file into `~/.inkpress/themes/` — it's that simple.

把 YAML 文件放到 `~/.inkpress/themes/` 即可。

```yaml
name: "My Theme"
description: "A custom theme"
series: "custom"

h1:
  style: |
    font-size: 24px;
    color: #333;
    font-weight: bold;

paragraph:
  style: |
    font-size: 15px;
    line-height: 1.75;
    color: #444;
```

See `themes/_template.yaml` for the full field reference.

完整字段参考见 `themes/_template.yaml`。

---

## Project Structure / 项目结构

```
inkpress/          Python core engine / Python 转换引擎
themes/            YAML theme files / YAML 主题定义
showcase/          Static showcase site (GitHub Pages) / 展示网站
skills/inkpress/   Claude Code Skill definition
scripts/           Build scripts / 构建脚本
```

---

## Use as Claude Code Skill

```bash
claude skill install /path/to/inkpress/skills/inkpress
```

Then say: "帮我用 aurora 主题排版这篇文章" / "Format this article with the aurora theme"

---

## License

MIT — free for personal and commercial use.
