Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New README for NexT #1155

Merged
merged 25 commits into from
Oct 7, 2019
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 16 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@

## Installation

Simplest way to install is by cloning the entire repository:
The simplest way to install is to clone the entire repository:

```sh
$ cd hexo
$ git clone https://github.com/theme-next/hexo-theme-next themes/next
```
```sh
$ cd hexo
$ git clone https://github.com/theme-next/hexo-theme-next themes/next
```

Or you can see [detailed installation instructions][docs-installation-url] if you want any other variant.

Expand All @@ -53,7 +53,7 @@ pjax: false

Then turn on `pjax` and go to «Dependencies» link with installation instructions of this module.

### Exceptions
### Configure CDN

If you use CDN for any plugins, you need to replace your CDN link.

Expand Down Expand Up @@ -83,19 +83,18 @@ However, you can bypass update errors by using the `Commit`, `Stash` or `Reset`

**If you want to update from v5.1.x to v6.0.x, read [here][docs-update-5-1-x-url].**

## Contributing

Contribution is welcome, feel free to open an issue and fork. Waiting for your pull request.

## Feedback

* Join our [Gitter][gitter-url] / [Riot][riot-url] / [Telegram][t-chat-url] chats.
* Follow us with [Telegram Channel][t-news-url] for latest news.
* Visit the [Awesome NexT][awesome-next-url] list.
* Ask a question on [Stack Overflow][stack-url].
* Report a bug in [GitHub Issues][issues-bug-url].
* Request a new feature on [GitHub][issues-feat-url].
* Vote for [popular feature requests][feat-req-vote-url].
* Join to our [Gitter][gitter-url] / [Riot][riot-url] / [Telegram][t-chat-url] chats.
* Follow us with [Telegram Channel][t-news-url] for latest news.

## Contributing

Contribution is welcome, feel free to open an issue and fork. Waiting for your pull request.

## Thanks

Expand Down Expand Up @@ -127,23 +126,17 @@ Contribution is welcome, feel free to open an issue and fork. Waiting for your p
[docs-data-files-url]: https://github.com/theme-next/hexo-theme-next/blob/master/docs/DATA-FILES.md
[docs-update-5-1-x-url]: https://github.com/theme-next/hexo-theme-next/blob/master/docs/UPDATE-FROM-5.1.X.md

[awesome-next-url]: https://github.com/theme-next/awesome-next
[stack-url]: https://stackoverflow.com/questions/tagged/theme-next
[issues-bug-url]: https://github.com/theme-next/hexo-theme-next/issues/new?assignees=&labels=Bug&template=bug-report.md
[issues-feat-url]: https://github.com/theme-next/hexo-theme-next/issues/new?assignees=&labels=Feature+Request&template=feature-request.md
[feat-req-vote-url]: https://github.com/theme-next/hexo-theme-next/issues?q=is%3Aopen+is%3Aissue+label%3A%22Feature+Request%22+sort%3Areactions-%2B1-desc

[gitter-url]: https://gitter.im/theme-next
[riot-url]: https://riot.im/app/#/room/#theme-next:matrix.org
[t-chat-url]: https://t.me/theme_next
[t-news-url]: https://t.me/theme_next_news

<!--[rel-image]: https://img.shields.io/github/release/theme-next/hexo-theme-next.svg-->
<!--[rel-image]: https://badge.fury.io/gh/theme-next%2Fhexo-theme-next.svg-->
<!--[mnt-image]: https://img.shields.io/maintenance/yes/2018.svg-->
[awesome-next-url]: https://github.com/theme-next/awesome-next
[issues-bug-url]: https://github.com/theme-next/hexo-theme-next/issues/new?assignees=&labels=Bug&template=bug-report.md
[issues-feat-url]: https://github.com/theme-next/hexo-theme-next/issues/new?assignees=&labels=Feature+Request&template=feature-request.md
[feat-req-vote-url]: https://github.com/theme-next/hexo-theme-next/issues?q=is%3Aopen+is%3Aissue+label%3A%22Feature+Request%22+sort%3Areactions-%2B1-desc

<!--[download-latest-url]: https://github.com/theme-next/hexo-theme-next/archive/master.zip-->
<!--[releases-latest-url]: https://github.com/theme-next/hexo-theme-next/releases/latest-->
<!--[releases-url]: https://github.com/theme-next/hexo-theme-next/releases-->
<!--[tags-url]: https://github.com/theme-next/hexo-theme-next/tags-->
<!--[commits-url]: https://github.com/theme-next/hexo-theme-next/commits/master-->
35 changes: 14 additions & 21 deletions docs/ru/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@

Простейший вариант установки — склонировать весь репозиторий:

```sh
$ cd hexo
$ git clone https://github.com/theme-next/hexo-theme-next themes/next
```
```sh
$ cd hexo
$ git clone https://github.com/theme-next/hexo-theme-next themes/next
```

Или предлагаю почитать [детальные инструкции по установке][docs-installation-url], если вариант выше не устраивает.

Expand Down Expand Up @@ -67,19 +67,18 @@ $ git pull

**Если нужно обновиться с версии v5.1.x на v6.0.x, читаем [здесь][docs-update-5-1-x-url].**

## Содействие

Приветсвуется любое содействие, не стесняйтесь сообщать «Баги», брать «Форки» и вливать «Пулы».

## Обратная связь

* Вступить в наши [Gitter][gitter-url] / [Riot][riot-url] / [Telegram][t-chat-url] чаты.
* Подписаться на новости через [канал Telegram'а][t-news-url].
* Посетите [Awesome NexT][awesome-next-url] список.
* Задать вопрос на [Stack Overflow][stack-url].
* Сообщить об ошибке в разделе [GitHub Issues][issues-bug-url].
* Запросить новую возможность на [GitHub][issues-feat-url].
* Голосовать за [популярные запросы возможностей][feat-req-vote-url].
* Вступить в наши [Gitter][gitter-url] / [Riot][riot-url] / [Telegram][t-chat-url] чаты.
* Подписаться на новости через [канал Telegram'а][t-news-url].

## Содействие

Приветсвуется любое содействие, не стесняйтесь сообщать «Баги», брать «Форки» и вливать «Пулы».

## Благодарности

Expand Down Expand Up @@ -111,23 +110,17 @@ $ git pull
[docs-data-files-url]: https://github.com/theme-next/hexo-theme-next/blob/master/docs/ru/DATA-FILES.md
[docs-update-5-1-x-url]: https://github.com/theme-next/hexo-theme-next/blob/master/docs/ru/UPDATE-FROM-5.1.X.md

[awesome-next-url]: https://github.com/theme-next/awesome-next
[stack-url]: https://stackoverflow.com/questions/tagged/theme-next
[issues-bug-url]: https://github.com/theme-next/hexo-theme-next/issues/new?assignees=&labels=Bug&template=bug-report.md
[issues-feat-url]: https://github.com/theme-next/hexo-theme-next/issues/new?assignees=&labels=Feature+Request&template=feature-request.md
[feat-req-vote-url]: https://github.com/theme-next/hexo-theme-next/issues?q=is%3Aopen+is%3Aissue+label%3A%22Feature+Request%22+sort%3Areactions-%2B1-desc

[gitter-url]: https://gitter.im/theme-next
[riot-url]: https://riot.im/app/#/room/#theme-next:matrix.org
[t-chat-url]: https://t.me/theme_next
[t-news-url]: https://t.me/theme_next_news

<!--[rel-image]: https://img.shields.io/github/release/theme-next/hexo-theme-next.svg-->
<!--[rel-image]: https://badge.fury.io/gh/theme-next%2Fhexo-theme-next.svg-->
<!--[mnt-image]: https://img.shields.io/maintenance/yes/2018.svg-->
[awesome-next-url]: https://github.com/theme-next/awesome-next
[issues-bug-url]: https://github.com/theme-next/hexo-theme-next/issues/new?assignees=&labels=Bug&template=bug-report.md
[issues-feat-url]: https://github.com/theme-next/hexo-theme-next/issues/new?assignees=&labels=Feature+Request&template=feature-request.md
[feat-req-vote-url]: https://github.com/theme-next/hexo-theme-next/issues?q=is%3Aopen+is%3Aissue+label%3A%22Feature+Request%22+sort%3Areactions-%2B1-desc

<!--[download-latest-url]: https://github.com/theme-next/hexo-theme-next/archive/master.zip-->
<!--[releases-latest-url]: https://github.com/theme-next/hexo-theme-next/releases/latest-->
<!--[releases-url]: https://github.com/theme-next/hexo-theme-next/releases-->
<!--[tags-url]: https://github.com/theme-next/hexo-theme-next/tags-->
<!--[commits-url]: https://github.com/theme-next/hexo-theme-next/commits/master-->
49 changes: 21 additions & 28 deletions docs/zh-CN/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,32 +32,32 @@

最简单的安装方式是直接克隆整个仓库:

```sh
$ cd hexo
$ git clone https://github.com/theme-next/hexo-theme-next themes/next
```
```sh
$ cd hexo
$ git clone https://github.com/theme-next/hexo-theme-next themes/next
```

此外,如果你想要使用其他方式,你也可以参见[详细安装步骤][docs-installation-url]。

## 插件

在 NexT 配置中你现在可以找到已经被移至外部仓库的依赖项。你可以在[组织主页](https://github.com/theme-next)中找到它们。
在 NexT 配置中有一些第三方插件,它们已经被移至外部仓库。你可以在[组织主页](https://github.com/theme-next)中找到它们。

例如,假设你想要在你的站点中使用 `pjax` 插件,请进入 NexT 配置文件,你会看到如下内容:
例如,你想要在你的站点中使用 `pjax` 插件,请进入 NexT 配置文件,你会看到如下内容:

```yml
# Easily enable fast Ajax navigation on your website.
# Dependencies: https://github.com/theme-next/theme-next-pjax
pjax: false
```

`pjax` 配置项打开,进入它上面的 «Dependencies» 链接以查看它的安装步骤。
启用 `pjax` 配置项,打开它上面的 «Dependencies» 链接以查看它的安装步骤。

### 例外
### 设置 CDN

如果你使用的插件脚本依赖 CDN,那么需要替换你的 CDN 链接
如果你想要通过 CDN 来加载插件脚本,那么需要设置相关的 CDN 链接

例如,假如你使用了 `mediumzoom` 插件并且配置了 CDN 加载链接,进入 Next 配置文件,你会看到如下内容:
例如,你使用了 `mediumzoom` 插件并且配置了 CDN 加载链接,进入 Next 配置文件,你会看到如下内容:

```yml
vendors:
Expand All @@ -67,7 +67,7 @@ vendors:
mediumzoom: # Set or update mediumzoom CDN URL.
```

通过替换 CDN 链接来替换 [插件列表](https://github.com/theme-next) 项目来升级
通过设置 CDN 链接来代替通过 [插件列表](https://github.com/theme-next) 项目进行升级

## 更新

Expand All @@ -83,19 +83,18 @@ $ git pull

**如果你想要从 v5.1.x 更新到 v6.0.x,阅读[这篇文档][docs-update-5-1-x-url]。**

## 贡献你的代码

我们欢迎你贡献出你的一份力量,你可以随时提交 issue 或 fork 本仓库。静候你的 pull request。

## 反馈

* 加入我们的 [Gitter][gitter-url] / [Riot][riot-url] / [Telegram][t-chat-url] 聊天。
* 关注我们的 [Telegram Channel][t-news-url] 以获取最新消息。
* 浏览 [Awesome NexT][awesome-next-url] 列表。
* 在 [Stack Overflow][stack-url] 上提问。
* 在 [GitHub Issues][issues-bug-url] 报告Bug。
* 在 [GitHub][issues-feat-url] 请求新的功能。
* 为 [受欢迎的 Feature request][feat-req-vote-url] 投票。
* 加入我们的 [Gitter][gitter-url] / [Riot][riot-url] / [Telegram][t-chat-url] 聊天。
* 关注我们的 [Telegram Channel][t-news-url] 以获取最新消息。

## 贡献你的代码

我们欢迎你贡献出你的一份力量,你可以随时提交 issue 或 fork 本仓库。静候你的 pull request。

## 鸣谢

Expand Down Expand Up @@ -127,23 +126,17 @@ $ git pull
[docs-data-files-url]: https://github.com/theme-next/hexo-theme-next/blob/master/docs/zh-CN/DATA-FILES.md
[docs-update-5-1-x-url]: https://github.com/theme-next/hexo-theme-next/blob/master/docs/zh-CN/UPDATE-FROM-5.1.X.md

[awesome-next-url]: https://github.com/theme-next/awesome-next
[stack-url]: https://stackoverflow.com/questions/tagged/theme-next
[issues-bug-url]: https://github.com/theme-next/hexo-theme-next/issues/new?assignees=&labels=Bug&template=bug-report.md
[issues-feat-url]: https://github.com/theme-next/hexo-theme-next/issues/new?assignees=&labels=Feature+Request&template=feature-request.md
[feat-req-vote-url]: https://github.com/theme-next/hexo-theme-next/issues?q=is%3Aopen+is%3Aissue+label%3A%22Feature+Request%22+sort%3Areactions-%2B1-desc

[gitter-url]: https://gitter.im/theme-next
[riot-url]: https://riot.im/app/#/room/#theme-next:matrix.org
[t-chat-url]: https://t.me/theme_next_chinese
[t-news-url]: https://t.me/theme_next_news

<!--[rel-image]: https://img.shields.io/github/release/theme-next/hexo-theme-next.svg-->
<!--[rel-image]: https://badge.fury.io/gh/theme-next%2Fhexo-theme-next.svg-->
<!--[mnt-image]: https://img.shields.io/maintenance/yes/2018.svg-->
[awesome-next-url]: https://github.com/theme-next/awesome-next
[issues-bug-url]: https://github.com/theme-next/hexo-theme-next/issues/new?assignees=&labels=Bug&template=bug-report.md
[issues-feat-url]: https://github.com/theme-next/hexo-theme-next/issues/new?assignees=&labels=Feature+Request&template=feature-request.md
[feat-req-vote-url]: https://github.com/theme-next/hexo-theme-next/issues?q=is%3Aopen+is%3Aissue+label%3A%22Feature+Request%22+sort%3Areactions-%2B1-desc

<!--[download-latest-url]: https://github.com/theme-next/hexo-theme-next/archive/master.zip-->
<!--[releases-latest-url]: https://github.com/theme-next/hexo-theme-next/releases/latest-->
<!--[releases-url]: https://github.com/theme-next/hexo-theme-next/releases-->
<!--[tags-url]: https://github.com/theme-next/hexo-theme-next/tags-->
<!--[commits-url]: https://github.com/theme-next/hexo-theme-next/commits/master-->