Skip to content

INFO-studio/rime-style

Repository files navigation

中州韵 饰毫

一个基于 Web 的 Rime 输入法样式制作工具。

本工具可以让你在实时预览的模式下自定义 Rime 输入法的外观。你可以修改颜色、字体、布局等,然后导出配置文件供 Rime 使用。

功能

  • 实时预览样式变更。
  • 自定义颜色、字体和布局。
  • 将你的样式导出为 YAML 文件。
  • 导入现有样式 (TODO)。

技术栈

  • 前端: React, TypeScript, Vite
  • 样式: Tailwind CSS
  • 状态管理: hox
  • 代码检查: ESLint
  • 代码格式化: Prettier

开始使用

环境要求

  • Node.js (v18 或更高版本)
  • pnpm

安装

  1. 克隆仓库:
    git clone https://github.com/GIT_USERNAME/rime-style.git
  2. 进入项目目录:
    cd rime-style
  3. 安装依赖:
    pnpm install

运行开发服务器

要启动开发服务器,请运行以下命令:

pnpm dev

这将在 http://localhost:5173 启动应用程序。

可用脚本

  • pnpm dev: 启动开发服务器。
  • pnpm build: 构建用于生产环境的应用程序。
  • pnpm format: 使用 Prettier 格式化代码。
  • pnpm lint: 使用 ESLint 检查代码。
  • pnpm preview: 预览生产环境的构建。

Rime Style Creator

A web-based style creator for the Rime input method editor.

This tool allows you to customize the appearance of the Rime UI with a live preview. You can modify colors, fonts, layout, and more, and then export the configuration for use with Rime.

Features

  • Live preview of your style changes.
  • Customize colors, fonts, and layout.
  • Export your style as a YAML file.
  • Import existing styles (TODO).

Tech Stack

  • Frontend: React, TypeScript, Vite
  • Styling: Tailwind CSS
  • State Management: hox
  • Linting: ESLint
  • Formatting: Prettier

Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • pnpm

Installation

  1. Clone the repository:
    git clone https://github.com/GIT_USERNAME/rime-style.git
  2. Navigate to the project directory:
    cd rime-style
  3. Install the dependencies:
    pnpm install

Running the Development Server

To start the development server, run the following command:

pnpm dev

This will start the application on http://localhost:5173.

Available Scripts

  • pnpm dev: Starts the development server.
  • pnpm build: Builds the application for production.
  • pnpm format: Formats the code with Prettier.
  • pnpm lint: Lints the code with ESLint.
  • pnpm preview: Previews the production build.

Contributors