Skip to content

Commit

Permalink
📝 Docs: update README for usage
Browse files Browse the repository at this point in the history
  • Loading branch information
Lruihao committed Jan 9, 2025
1 parent b124218 commit 95e83ca
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 18 deletions.
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,31 @@
More FixIt examples <a href="https://fixit.lruihao.cn/showcase/">here</a>.
</p>

## Documentation
## Why choose FixIt

I don't know why 🤷.

<!-- Too lazy to write... -->

## Usage

### Documentation

Head to the [Quick Start](https://fixit.lruihao.cn/documentation/getting-started/quick-start/) page for a step-by-step guide on how to create a new website with FixIt.

Outline: [Installation](https://fixit.lruihao.cn/documentation/installation/)[Getting Started](https://fixit.lruihao.cn/documentation/getting-started/)[Content Management](https://fixit.lruihao.cn/documentation/content-management/)[Advanced Usage](https://fixit.lruihao.cn/documentation/advanced/)

## Template repository
### Starter Wizard

We provided a CLI tool to help you create a new project with FixIt by a single command.

```bash
pnpx fixit-cli create my-blog
```

[![asciicast](https://asciinema.org/a/697494.svg)](https://asciinema.org/a/697494)

### Templates

Click the following links to generate a new repository with template:

Expand All @@ -61,12 +79,6 @@ Click the following links to generate a new repository with template:
[lruihao-blog]: https://github.com/Lruihao/hugo-blog
[lruihao-blog:generate]: https://github.com/Lruihao/hugo-blog/generate

## Why choose FixIt

I don't know why 🤷

<!-- Too lazy to write... -->

## Features

### Performance and SEO
Expand Down
32 changes: 22 additions & 10 deletions README.zh-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,31 @@
更多 FixIt 的例子参见 <a href="https://fixit.lruihao.cn/zh-cn/showcase/">这里</a>。
</p>

## 主题文档
## 为什么选择 FixIt

我也不知道为什么 🤷。

<!-- 懒的写…… -->

## 使用指南

### 主题文档

前往 [快速上手](https://fixit.lruihao.cn/zh-cn/documentation/getting-started/quick-start/) 页面,了解如何使用 FixIt 主题创建一个新网站的详细步骤。

大纲:[安装篇](https://fixit.lruihao.cn/zh-cn/documentation/installation/)[入门篇](https://fixit.lruihao.cn/zh-cn/documentation/getting-started/)[内容管理](https://fixit.lruihao.cn/zh-cn/documentation/content-management/)[进阶篇](https://fixit.lruihao.cn/zh-cn/documentation/advanced/)

## 模板仓库
### 快速开始

我们提供了一个 CLI 工具,可以通过一个命令来创建一个新的 FixIt 项目。

```bash
pnpx fixit-cli create my-blog
```

[![asciicast](https://asciinema.org/a/697494.svg)](https://asciinema.org/a/697494)

### 模板

点击以下链接使用模板生成一个新的仓库:

Expand All @@ -61,11 +79,9 @@
[lruihao-blog]: https://github.com/Lruihao/hugo-blog
[lruihao-blog:generate]: https://github.com/Lruihao/hugo-blog/generate

## 为什么选择 FixIt

我也不知道为什么 🤷
### 镜像

<!-- 懒的写…… -->
Gitee 镜像仓库:<https://gitee.com/lruihao/FixIt>

## 特性

Expand Down Expand Up @@ -178,10 +194,6 @@ FixIt 支持下列语言:

[语言兼容性](https://fixit.lruihao.cn/zh-cn/theme-documentation-basics/#language-compatibility)

## 镜像

Gitee 镜像仓库:<https://gitee.com/lruihao/FixIt>

## 社区支持

所有的反馈都是欢迎的!详见 [Discussions][discussions][Pull requests][pulls][Issues][issues]
Expand Down

0 comments on commit 95e83ca

Please sign in to comment.