Kinky Dungeon Wiki

Appearance

Wiki协助指南 | 项目介绍 ​

技术栈 ​

  • 前端：Vue3 + Ant Design Vue 4 + VitePress + Markdown + TypeScript

项目结构 ​

TIP

已省略部分无关文件

md
├── docs
│   ├── .vitepress
│   │   ├── config.mts // VitePress 配置文件 包含路由信息
│   ├── components // 自定义组件
│   │   ├── table.vue // 表格组件
│   ├── md // 文档 wiki内容
│   │   ├── book // 图鉴相关
│   │   │   ├── bookItem.md // 图鉴 - 道具总览
│   │   ├── mods // 模组相关
│   │   │   ├── mods.md // Mod列表
│   ├── public // 静态资源
│   ├── utils // 工具函数
│   ├── index.md // 首页

本地运行项目 ​

运行环境 ​

  • Node.js 22.0.0 或更高版本
  • Git
  • yarn

安装环境 ​

  • 下载Node.js 推荐使用nvm安装

nvm：下载地址

  • 安装nvm后 打开终端输入(打开开始菜单输入cmd唤出或打开powerShell)

  • 在终端输入nvm ls 查看nvm是否安装成功 如无报红则安装成功

  • 在终端输入nvm install 22 安装Node.js版本

  • 在终端输入nvm use 22 切换到Node.js 22版本

  • 在终端输入node -v 查看Node.js版本 如为22则安装成功

  • 在终端输入npm install -g yarn 安装yarn

  • 在终端输入yarn -v 查看yarn版本 如无报红则安装成功

  • 下载git

git: 下载地址

  • 安装git 一路next即可

克隆项目 ​

在准备放置wiki项目的文件夹下 右键选择Open git bash here 打开git bash

在git bash中输入以下命令

bash
git clone https://gitee.com/miriru/kinky-dungeon-wiki.git

安装依赖 ​

在克隆下来的项目文件夹下打开终端 安装依赖

TIP

快速在当前文件夹打开终端: 在文件夹的地址栏输入cmd回车即可

bash
yarn

启动项目 ​

bash
yarn dev

访问项目 ​

打开浏览器，访问 localhost:5173 即可查看项目。

贡献指南 ​

欢迎对本项目进行贡献，可以通过以下方式参与：

直接修改dev分支 并提交PR ​

1. Clone 本仓库 ​

2. 在dev分支上修改 ​

3. 提交PR ​

将md文件提交给我 ​

1. Clone 本仓库 ​

2. 在本地修改完md文件后 将更改的md文件打包发给我 ​

联系方式 ​

如有任何问题或建议，请通过以下方式联系我们：

技术相关 ​