KitX 文档站

简体中文

English

简体中文

English

外观

快速上手

约 575 字大约 2 分钟

2025-01-25

获取源码

Clone 主仓库

KitX 项目使用 Git 进行版本控制, 您可以通过以下命令获取源码:

git clone git@github.com:Crequency/KitX.git --recurse-submodules
cd KitX

注意

暂不支持通过 https 协议获取子模块, 强烈建议配置本地 git 以及 ssh 环境

初始化依赖

使用 cheese 来选择初始化子模块并进行相关设置:

初始化依赖
cheese reference --setup

如果遇到 cheese 命令出错的情况, 可以添加 --verbose 参数来查看详细错误信息

构建项目

编译前准备

  1. 您需要安装 dotnet 8 SDK, 请前往 dotnet 官网 下载并安装 安装成功的标志是: 成功运行命令 dotnet --list-sdks 并且列出了 dotnet 8 SDK 的版本号

编译

您只需要 cd 至您想要编译的项目目录 (包含 .csproj 文件), 然后运行以下命令即可:

dotnet build

若运行命令 dotnet run 则会自动编译并运行项目

面向发布的编译

您可能会注意到, 在 KitX Dashboard/Properties/PublishProfiles/ 下有许多 .pubxml 后缀的文件

这些便是发布配置文件, 您可以使用命令:

cd "KitX Dashboard"
dotnet publish /p:Profile=Properties/PublishProfiles/<xxx>.pubxml

来使用这些配置文件进行发布, 其中 <xxx> 为配置文件名

发布后的二进制文件将存在于 KitX Publish/ 下

您也可以执行以下命令来一键发布所有配置文件:

cheese scripts -e publish

其它构建方式

您也可以使用一些 IDE 来构建项目 例如:

  • Visual Studio (建议使用 2022 版本)
  • Jetbrains Rider

其中, 您可以在 Visual Studio 中右键解决方案资源管理器中的项目, 选择 发布, 然后选择发布配置文件来进行发布 您也可以在 Rider 中使用类似的操作来进行发布

或者, 您也可以配置编辑器来简化构建步骤 例如:

  • Visual Studio Code
  • Vim

此处省略配置编辑器的步骤, 请自行搜索相关教程

贡献者

变更历史

最后更新于: 查看全部变更历史

  • 💾 Feat: Updating translation for English

    于 2025/2/8

  • 💾 Feat(Plume-Theme): Migrated

    于 2025/1/25

  • 📝 Chore: Remove hard-coded permalink

    于 2025/1/25

  • 📦 Struct: Move to notes folder to match theme's requirements

    于 2025/1/25
  • v23.10.15.0于 2023/10/15
  • v23.05.06.0于 2023/5/6

  • 📄 Docs(getting-started): Part of start list.

    于 2023/3/27

  • 📦 Struct: Move all files under guide to client/guide

    于 2023/3/22

  • 📄 Docs: Updated clone codes.

    于 2023/3/22

  • 📄 Docs: 更准确的描述

    于 2023/3/14

  • Update getting-started.md

    于 2023/3/14

  • 📄 Docs: 更新 getting-started.md

    于 2023/3/14

  • 📦 Struct: Move default to root dir

    于 2023/2/21

  • 📝 📦 Chore, Struct: 按主题分离

    于 2023/1/21

  • 📝 📦 Chore, Struct: 尝试 hope 主题

    于 2023/1/21

  • 📄 Docs: 快速开始相关的教程

    于 2023/1/20

  • 📄 📝 Docs, Chore: 初始化项目架构; 初始化文档架构

    于 2023/1/20

  • 💾 📝 📦 Feat, Chore, Struct: 使用 vuepress 重建文档站

    于 2023/1/20