快速开始
按照Kecare相当简单,仅需安装Kecare CLI 即可帮你从0开始一个 Kecare 项目。它将引导你完成设置新项目的每一步,并允许你从几个不同的官方入门模板中进行选择。如果你只是想为你的已有项目中快速接入一个博客/文档站,请阅读
先决条件
- Node.js
- 终端
- Git
安装 CLI
你可以在你的机器上的任何地方运行 create kecare,它将会为你安装Kecare 生成器CLI
npm create kecare
如果一切顺利,你将看到一条成功消息。
获取主题或入门模板
[!NOTE]
目前 Kecare 诞生不久,所以目前并没有太多的主题可供选择,感谢大家为 Kecare 贡献主题以充实生态。大家可以先使用我们提供的一套主题来体验 Kecare 带来的优势
git clone https://github.com/Pamperkyumi/Kecare-theme.git
cd Kecare-theme
安装依赖
bun install
如果一切顺利,你将会获得一份主要有以下目录的主题,
theme/
├── .kecare/
│ ├── articles/ # 文章目录(将markdown文章放置于此)
│ │
│ ├── menus/
│ │ ├── test.menu.source.ts # 菜单源文件(用于菜单导航栏)
│ │
│ ├── foo-bar.article.ts # 文章详情页模板
│ ├── foo-bar.list.ts # 列表页模板
│ ├── foo-bar.archives.ts # 归档页模板
│
│
├── app/ # Nuxt 应用目录
...
我们的主题是用Nuxt进行的构建,但在实际使用中,Kecare并不限制你框架的使用,所以我们并不对Nuxt目录展开过多叙述
启动开发服务器
你可在.kecare/articls/中编写你的markdown文章,让后使用使用kecare gen .进行生成对应的页面
待生成器将所需页面都生成完毕之后,你就可以使用npm run dev来启动你的开发服务器了。