Skip to content

Commit

Permalink
📝 Docs: organize README content
Browse files Browse the repository at this point in the history
  • Loading branch information
Lruihao committed Jan 14, 2025
1 parent 2f56442 commit 1739d69
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 27 deletions.
35 changes: 22 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,9 @@ Click the following links to generate a new repository with template:

## Features

<details>
<summary>Click to view.</summary>

### Performance and SEO

- Optimized for **performance**: 99/100 on mobile and 100/100 on desktop in [Google PageSpeed Insights](https://developers.google.com/speed/pagespeed/insights)
Expand Down Expand Up @@ -160,20 +163,14 @@ Click the following links to generate a new repository with template:
- Options to **cache remote image** locally
- ...

### Theme Components

The FixIt theme balances **simplicity** and **extensibility** with extra [Hugo theme components](https://fixit.lruihao.cn/ecosystem/#-components) for customization.

- GitHub projects card supported by [component-projects](https://github.com/hugo-fixit/component-projects)
- Automatic Translation supported by [cmpt-translate](https://github.com/hugo-fixit/cmpt-translate)
- JSON feed supported by [hugo-json-feed](https://github.com/hugo-fixit/hugo-json-feed)
- `reward-log` shortcode supported by [shortcode-reward](https://github.com/hugo-fixit/shortcode-rewards)
- `caniuse` shortcode supported by [shortcode-caniuse](https://github.com/hugo-fixit/shortcode-caniuse)
- ...
</details>

## Multilingual and i18n

FixIt supports the following languages:
FixIt supports multilingual and i18n. For more information, see the [Content Management](https://fixit.lruihao.cn/documentation/content-management/introduction#multilingual) documentation. You are welcome to [contribute with a new language](https://github.com/hugo-fixit/FixIt/pulls).

<details>
<summary>FixIt supports the following languages.</summary>

- English
- Simplified Chinese
Expand All @@ -189,9 +186,21 @@ FixIt supports the following languages:
- Romanian
- Vietnamese
- Hindi
- [Contribute with a new language](https://github.com/hugo-fixit/FixIt/pulls)

[Languages Compatibility](https://fixit.lruihao.cn/documentation/basics/#language-compatibility)
</details>

## Theme Components

The FixIt theme balances **simplicity** and **extensibility** with extra [Hugo theme components](https://fixit.lruihao.cn/ecosystem/#-components) for customization.

<details>
<summary>Click to view.</summary>

<!-- COMPONENT_LIST_START -->

<!-- COMPONENT_LIST_END -->

</details>

## Community

Expand Down
37 changes: 23 additions & 14 deletions README.zh-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,10 @@ pnpx fixit-cli create my-blog

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

## 特性
## 特色

<details>
<summary>点击展开</summary>

### 性能和 SEO

Expand Down Expand Up @@ -164,20 +167,14 @@ Gitee 镜像仓库:<https://gitee.com/lruihao/FixIt>
- 支持本地**缓存远程图床图片**
- ……

### 主题组件

FixIt 主题旨在在**简洁性****可扩展性**之间取得平衡。为此,我们开发了一系列额外的 [Hugo 主题组件](https://fixit.lruihao.cn/zh-cn/ecosystem/#-组件) 供用户选择。

- GitHub 项目卡片支持 [component-projects](https://github.com/hugo-fixit/component-projects)
- 自动翻译支持 [cmpt-translate](https://github.com/hugo-fixit/cmpt-translate)
- JSON feed 支持 [hugo-json-feed](https://github.com/hugo-fixit/hugo-json-feed)
- `reward-log` shortcode 支持 [shortcode-reward](https://github.com/hugo-fixit/shortcode-rewards)
- `caniuse` shortcode 支持 [shortcode-caniuse](https://github.com/hugo-fixit/shortcode-caniuse)
- ……
</details>

## 多语言和国际化

FixIt 支持下列语言:
FixIt 主题多语言基本配置及自动翻译等详见 [内容管理](https://fixit.lruihao.cn/zh-cn/documentation/content-management/introduction#multilingual) 文档,欢迎 [贡献一种新的语言](https://github.com/hugo-fixit/FixIt/pulls)

<details>
<summary>FixIt 支持下列语言。</summary>

- 英语
- 简体中文
Expand All @@ -193,9 +190,21 @@ FixIt 支持下列语言:
- 罗马尼亚语
- 越南语
- 印地语
- [贡献一种新的语言](https://github.com/hugo-fixit/FixIt/pulls)

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

## 主题组件

FixIt 主题旨在在**简洁性****可扩展性**之间取得平衡。为此,我们开发了一系列额外的 [Hugo 主题组件](https://fixit.lruihao.cn/zh-cn/ecosystem/#-组件) 供用户选择。

<details>
<summary>点击展开</summary>

<!-- COMPONENT_LIST_START -->

<!-- COMPONENT_LIST_END -->

</details>

## 社区支持

Expand Down

0 comments on commit 1739d69

Please sign in to comment.