Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenjoezhang committed Oct 7, 2019
1 parent 58bc65d commit 88422ee
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 12 deletions.
1 change: 0 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,6 @@ Pull requests related:
- `Discussion`: A pull request that needs to be discussed
- `Work in Progress`: A pull request that is still working in progress
- `Skip Release`: A pull request that should be excluded from release note
- `v6.x`: A pull request that bug fixes and some improvements, related to old NexT version 6
<a name="commit-messages-rules"></a>
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ $ git pull
And if you see any error message during update (something like **«Commit your changes or stash them before you can merge»**), recommended to learn [Hexo data files][docs-data-files-url] feature.\
However, you can bypass update errors by using the `Commit`, `Stash` or `Reset` commands for local changes. See [here](https://stackoverflow.com/a/15745424/5861495) how to do it.

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

## Feedback

Expand Down
4 changes: 2 additions & 2 deletions docs/UPDATE-FROM-5.1.X.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">Update from NexT v5.1.x</h1>

There are no hard breaking changes between 5.1.x and 6.0.x versions. It's change major version to 6 because:
There are no hard breaking changes between 5.1.x and the latest version. It's change major version to 6 because:

1. Main repo was rebased from [iissnan's](https://github.com/iissnan/hexo-theme-next) profile to [theme-next](https://github.com/theme-next) organization.
2. Most libraries under the `next/source/lib` directory was moved out to [external repos under NexT organization](https://github.com/theme-next).
Expand All @@ -13,7 +13,7 @@ So, i suggest to update from version 5 to version 6 in this way:
1.2. Custom CSS styles what placed in `next/source/css/_custom/*` and `next/source/css/_variables/*` directories.\
1.3. Custom layout styles what placed in `next/layout/_custom/*`.\
1.4. Any another possible custom additions which can be finded by compare tools between repos.
2. Clone new v6.x repo to any another directory instead of `next`. For example, in `next-reloaded` directory: `git clone https://github.com/theme-next/hexo-theme-next themes/next-reloaded`. So, you don't touch your old NexT 5.1.x directory and can work with new `next-reloaded` dir.
2. Clone new repo to any another directory instead of `next`. For example, in `next-reloaded` directory: `git clone https://github.com/theme-next/hexo-theme-next themes/next-reloaded`. So, you don't touch your old NexT 5.1.x directory and can work with new `next-reloaded` dir.
3. Go to Hexo main config and set theme parameter: `theme: next-reloaded`. So, your `next-reloaded` directory must loading with your generation. If you may see any bugs or you simply not like this version, you anytime can switch for 5.1.x version back.
4. Update language configuration (For Chinese)

Expand Down
2 changes: 1 addition & 1 deletion docs/ru/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ $ git pull
А если всплывают ошибки во время обновления (что-то наподобии **«Commit your changes or stash them before you can merge»**), рекомендуется ознакомиться с особенностью хранения [дата-файлов в Hexo][docs-data-files-url].\
Как бы то ни было, можно обойти ошибки при обновлении если «Закомитить», «Стэшнуть» или «Откатить» локальные изменения. Смотрим [здесь](https://stackoverflow.com/a/15745424/5861495) как это сделать.

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

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

Expand Down
5 changes: 2 additions & 3 deletions docs/ru/UPDATE-FROM-5.1.X.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<h1 align="center">Обновление из-под NexT v5.1.x</h1>

Между версиями 5.1.x и 6.0.x нет жёстких изменений. Версия сменилась на мажорную 6 по следующим причинам:

Между версией 5.1.x и последней версиями нет жёстких изменений. Версия сменилась на мажорную 6 по следующим причинам:
1. Основной репозиторий перебазировался из профиля [iissnan'а](https://github.com/iissnan/hexo-theme-next) в [theme-next](https://github.com/theme-next) организацию.
2. Большинство библиотек в `next/source/lib` директории были вынесены в [отдельные репозитории под организацией NexT](https://github.com/theme-next).
3. 3rd-party плагин [`hexo-wordcount`](https://github.com/willin/hexo-wordcount) был заменён на [`hexo-symbols-count-time`](https://github.com/theme-next/hexo-symbols-count-time) т.к. `hexo-symbols-count-time` не имеет никаких сторонних nodejs зависимостей, не имеет [языкового фильтра](https://github.com/willin/hexo-wordcount/issues/7) что обеспечивает улучшенную производительность при генерации сайта.
Expand All @@ -13,7 +12,7 @@
1.2. Пользовательских CSS-стилей, которые расположены в `next/source/css/_custom/*` и `next/source/css/_variables/*` директориях.\
1.3. Пользовательских layout-стилей, которые расположены в `next/layout/_custom/*`.\
1.4. Любые другие всевозможные пользовательские изменения, которые могут быть найдены любым инструментом для сравнения файлов.
2. Склонировать новый v6.x репозиторий в любую другую директорию, отличную от `next`. Например, в директорию `next-reloaded`: `git clone https://github.com/theme-next/hexo-theme-next themes/next-reloaded`. Итак, нет необходимости трогать старую NexT 5.1.x директорию и можно работать с новой `next-reloaded`.
2. Склонировать новый репозиторий в любую другую директорию, отличную от `next`. Например, в директорию `next-reloaded`: `git clone https://github.com/theme-next/hexo-theme-next themes/next-reloaded`. Итак, нет необходимости трогать старую NexT 5.1.x директорию и можно работать с новой `next-reloaded`.
3. Открываем главную Hexo-конфигурацию и устанавливаем параметр темы: `theme: next-reloaded`. Так Ваша директория `next-reloaded` должна грузиться при генерации. Если Вы будете наблюдать какие-либо баги или Вам попросту не нравится эта новая версия, в любой момент Вы можете использовать старую 5.1.x.

А как активировать 3rd-party библиотеки, смотрим здесь [здесь](https://github.com/theme-next/hexo-theme-next/blob/master/docs/ru/INSTALLATION.md#%D0%9F%D0%BB%D0%B0%D0%B3%D0%B8%D0%BD%D1%8B).
1 change: 0 additions & 1 deletion docs/zh-CN/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,6 @@ Pull requests 的标签:
- `Discussion`: 需要进行讨论的 Pull request
- `Work in Progress`: 仍在进行改动和完善的 Pull request
- `Skip Release`: 无需在 Release Note 中展现的 Pull request
- `v6.x`: 与 NexT v6.x 旧版相关的用于修复和改进的 Pull request
<a name="commit-messages-rules"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/zh-CN/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ $ git pull
如果你在此过程中收到了任何错误报告 (例如 **«Commit your changes or stash them before you can merge»**),我们推荐你使用 [Hexo 数据文件][docs-data-files-url]特性。\
然而你也可以通过提交(`Commit`)、贮藏(`Stash`)或忽视(`Discard`)本地更改以绕过这种更新错误。具体方法请参考[这里](https://stackoverflow.com/a/15745424/5861495)。

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

## 反馈

Expand Down
4 changes: 2 additions & 2 deletions docs/zh-CN/UPDATE-FROM-5.1.X.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">从 NexT v5.1.x 更新</h1>

在 5.1.x 版本和 6.0.x 版本之间没有很大的革命性改进。主版本号变更至 6 主要是因为:
在 5.1.x 版本和新版本之间没有很大的革命性改进。主版本号变更至 6 主要是因为:

1. 主仓库已从 [iissnan 名下](https://github.com/iissnan/hexo-theme-next) 迁移至 [theme-next](https://github.com/theme-next) 组织。
2. `next/source/lib` 目录下的绝大多数库被移出到了 [NexT 组织的外部仓库](https://github.com/theme-next)中。
Expand All @@ -13,7 +13,7 @@
2. 自定义的 CSS 配置,它们应在 `next/source/css/_custom/*``next/source/css/_variables/*` 中。
3. 自定义的排布配置,它们应在 `next/layout/_custom/*` 中。
4. 任何其它可能的附加自定义内容;为了定位它们,你可以通过某些工具在仓库间比较。
2. 克隆新的 v6.x 仓库到任一异于 `next` 的目录(如 `next-reloaded`):
2. 克隆新的仓库到任一异于 `next` 的目录(如 `next-reloaded`):
```sh
$ git clone https://github.com/theme-next/hexo-theme-next themes/next-reloaded
```
Expand Down

0 comments on commit 88422ee

Please sign in to comment.