Skip to content

Commit 615b9de

Browse files
ivan-nginxstevenjoezhang
authored andcommitted
New README for NexT (iissnan#1155)
1 parent ff8b8f4 commit 615b9de

14 files changed

+238
-244
lines changed

.github/CODE_OF_CONDUCT.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
<div align="right">Language: :us:
2-
<a title="Chinese" href="../docs/zh-CN/CODE_OF_CONDUCT.md">:cn:</a>
3-
<a title="Russian" href="../docs/ru/CODE_OF_CONDUCT.md">:ru:</a></div>
1+
<div align="right">
2+
Language:
3+
:us:
4+
<a title="Chinese" href="../docs/zh-CN/CODE_OF_CONDUCT.md">:cn:</a>
5+
<a title="Russian" href="../docs/ru/CODE_OF_CONDUCT.md">:ru:</a>
6+
</div>
47

58
# <div align="center"><a title="Go to homepage" href="https://theme-next.org"><img align="center" width="56" height="56" src="https://raw.githubusercontent.com/theme-next/hexo-theme-next/master/source/images/logo.svg?sanitize=true"></a> e x T</div>
69

.github/CONTRIBUTING.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
<div align="right">Language: :us:
2-
<a title="Chinese" href="../docs/zh-CN/CONTRIBUTING.md">:cn:</a>
3-
<a title="Russian" href="../docs/ru/CONTRIBUTING.md">:ru:</a></div>
1+
<div align="right">
2+
Language:
3+
:us:
4+
<a title="Chinese" href="../docs/zh-CN/CONTRIBUTING.md">:cn:</a>
5+
<a title="Russian" href="../docs/ru/CONTRIBUTING.md">:ru:</a>
6+
</div>
47

58
# <div align="center"><a title="Go to homepage" href="https://theme-next.org"><img align="center" width="56" height="56" src="https://raw.githubusercontent.com/theme-next/hexo-theme-next/master/source/images/logo.svg?sanitize=true"></a> e x T</div>
69

.travis.yml

-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ cache:
88

99
install: npm install
1010

11-
before_script:
12-
- npm install -g gulp
13-
1411
addons:
1512
browserstack:
1613
username: "ivannginx1"

README.md

+64-67
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,54 @@
1-
<div align="right">Language: :us:
2-
<a title="Chinese" href="docs/zh-CN/README.md">:cn:</a>
3-
<a title="Russian" href="docs/ru/README.md">:ru:</a></div>
1+
<div align="right">
2+
Language:
3+
:us:
4+
<a title="Chinese" href="docs/zh-CN/README.md">:cn:</a>
5+
<a title="Russian" href="docs/ru/README.md">:ru:</a>
6+
</div>
47

58
# <div align="center"><a title="NexT website repository" href="https://github.com/theme-next/theme-next.org"><img align="center" width="56" height="56" src="https://raw.githubusercontent.com/theme-next/hexo-theme-next/master/source/images/logo.svg?sanitize=true"></a> e x T</div>
69

7-
<p align="center">«NexT» is a high quality elegant <a href="http://hexo.io">Hexo</a> theme. It is crafted from scratch with love.</p>
8-
9-
<p align="center">
10-
<a href="https://bestpractices.coreinfrastructure.org/projects/2625"><img src="https://bestpractices.coreinfrastructure.org/projects/2625/badge" title="Core Infrastructure Initiative Best Practices"></a>
11-
<a href="https://www.codacy.com/app/theme-next/hexo-theme-next?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=theme-next/hexo-theme-next&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/72f7fe7609c2438a92069f448e5a341a" title="Project Grade"></a>
12-
<a href="https://travis-ci.org/theme-next/hexo-theme-next?branch=master"><img src="https://travis-ci.org/theme-next/hexo-theme-next.svg?branch=master" title="Travis CI [Linux]"></a>
13-
<a href="https://i18n.theme-next.org"><img src="https://d322cqt584bo4o.cloudfront.net/theme-next/localized.svg" title="Add or improve translation in few seconds!"></a>
14-
<a href="https://github.com/theme-next/hexo-theme-next/releases"><img src="https://badge.fury.io/gh/theme-next%2Fhexo-theme-next.svg"></a>
15-
<a href="http://hexo.io"><img src="https://img.shields.io/badge/hexo-%3E%3D%203.5.0-blue.svg"></a>
16-
<a href="https://github.com/theme-next/hexo-theme-next/blob/master/LICENSE.md"><img src="https://img.shields.io/badge/license-%20AGPL-blue.svg"></a>
17-
</p>
18-
1910
<p align="center">
11+
«NexT» is a high quality elegant <a href="https://hexo.io">Hexo</a> theme. It is crafted from scratch with love.
12+
<br>
13+
<br>
14+
<a href="https://github.com/theme-next/hexo-theme-next/releases"><img src="https://img.shields.io/github/package-json/v/theme-next/hexo-theme-next?style=flat-square"></a>
15+
<a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E=8.6.0-green?style=flat-square"></a>
16+
<a href="https://hexo.io"><img src="https://img.shields.io/badge/hexo-%3E=3.5.0-blue?style=flat-square&logo=hexo"></a>
17+
<a href="https://github.com/theme-next/hexo-theme-next/blob/master/LICENSE.md"><img src="https://img.shields.io/badge/license-%20AGPL-orange?style=flat-square&logo=gnu"></a>
18+
<br>
19+
<a href="https://bestpractices.coreinfrastructure.org/projects/2625"><img src="https://img.shields.io/cii/level/2625?style=flat-square" title="Core Infrastructure Initiative Best Practices"></a>
20+
<a href="https://travis-ci.org/theme-next/hexo-theme-next?branch=master"><img src="https://img.shields.io/travis/theme-next/hexo-theme-next/master?style=flat-square&logo=travis%20ci" title="Travis CI [Linux]"></a>
21+
<a href="https://app.codacy.com/manual/theme-next/hexo-theme-next/dashboard"><img src="https://img.shields.io/codacy/grade/72f7fe7609c2438a92069f448e5a341a/master?style=flat-square&logo=codacy" title="Project Grade"></a>
22+
<img src="https://img.shields.io/snyk/vulnerabilities/github/theme-next/hexo-theme-next?style=flat-square" title="Vulnerabilities">
23+
<br>
2024
<img src="https://user-images.githubusercontent.com/16272760/63487983-da41b080-c4df-11e9-951c-64883a8a5e9b.png">
2125
</p>
2226

2327
## Live Preview
2428

2529
<p align="center">
26-
:heart_decoration: <a href="https://muse.theme-next.org">Muse</a> | :six_pointed_star: <a href="https://mist.theme-next.org">Mist</a> | :pisces: <a href="https://pisces.theme-next.org">Pisces</a> | :gemini: <a href="https://theme-next.org">Gemini</a>
30+
:heart_decoration: <a href="https://muse.theme-next.org">Muse</a> | :six_pointed_star: <a href="https://mist.theme-next.org">Mist</a> | :pisces: <a href="https://pisces.theme-next.org">Pisces</a> | :gemini: <a href="https://theme-next.org">Gemini</a>
31+
<br>
32+
<br>
33+
More «NexT» examples <a href="https://github.com/theme-next/awesome-next#live-preview">here</a>.
2734
</p>
2835

29-
<p align="center">More «NexT» examples <a href="https://github.com/iissnan/hexo-theme-next/issues/119">here</a>.</p>
30-
3136
## Installation
3237

33-
Simplest way to install is by cloning the entire repository:
38+
The simplest way to install is to clone the entire repository:
3439

35-
```sh
36-
$ cd hexo
37-
$ git clone https://github.com/theme-next/hexo-theme-next themes/next
38-
```
40+
```sh
41+
$ cd hexo
42+
$ git clone https://github.com/theme-next/hexo-theme-next themes/next
43+
```
3944

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

4247
## Plugins
4348

4449
In NexT config now you can find dependencies on each module which was moved to external repositories which can be found by [main organization link](https://github.com/theme-next).
4550

46-
For example, if you want to use `pjax` in your site, go to NexT config and see:
51+
For example, if you want to enable `pjax` on your site, go to NexT config and see:
4752

4853
```yml
4954
# Easily enable fast Ajax navigation on your website.
@@ -53,7 +58,7 @@ pjax: false
5358
5459
Then turn on `pjax` and go to «Dependencies» link with installation instructions of this module.
5560

56-
### Exceptions
61+
### Configure CDN
5762

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

@@ -81,69 +86,61 @@ $ git pull
8186
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.\
8287
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.
8388

84-
**If you want to update from v5.1.x to v6.0.x, read [here][docs-update-5-1-x-url].**
85-
86-
## Contributing
87-
88-
Contribution is welcome, feel free to open an issue and fork. Waiting for your pull request.
89+
**If you want to update from v5.1.x to the latest version, read [this][docs-update-5-1-x-url].**
8990

9091
## Feedback
9192

93+
* Follow us with [Telegram Channel][t-news-url] for latest news.
94+
* Join our [Telegram][t-chat-url] / [Gitter][gitter-url] / [Riot][riot-url] chats.
95+
* [Add or improve translation][i18n-url] in few seconds.
9296
* Visit the [Awesome NexT][awesome-next-url] list.
93-
* Ask a question on [Stack Overflow][stack-url].
9497
* Report a bug in [GitHub Issues][issues-bug-url].
9598
* Request a new feature on [GitHub][issues-feat-url].
9699
* Vote for [popular feature requests][feat-req-vote-url].
97-
* Join to our [Gitter][gitter-url] / [Riot][riot-url] / [Telegram][t-chat-url] chats.
98-
* Follow us with [Telegram Channel][t-news-url] for latest news.
99100

100-
## Thanks
101+
## Contributing
101102

102-
<p align="center">
103-
«NexT» send special thanks to these great services that sponsor our core infrastructure:
104-
</p>
103+
Contribution is welcome, feel free to open an issue and fork. Waiting for your pull request.
105104

106-
<p align="center"><a href="https://github.com"><img align="center" width="100" src="https://github.githubassets.com/images/modules/logos_page/GitHub-Logo.png"></a>
107-
&nbsp;<a href="https://www.netlify.com"><img align="center" width="150" src="https://cdn.netlify.com/15ecf59b59c9d04b88097c6b5d2c7e8a7d1302d0/1b6d6/img/press/logos/full-logo-light.svg"></a></p>
108-
<p align="center">
109-
<sub>GitHub allows us to host the Git repository, Netlify allows us to distribute the documentation.</sub>
110-
</p>
105+
## Thanks
111106

112-
<p align="center"><a href="https://crowdin.com"><img align="center" width="180" src="https://support.crowdin.com/assets/logos/crowdin-logo1-small.png"></a></p>
113107
<p align="center">
108+
«NexT» send special thanks to these great services that sponsor our core infrastructure:
109+
<br>
110+
<br>
111+
<a href="https://github.com"><img align="center" width="100" src="https://github.githubassets.com/images/modules/logos_page/GitHub-Logo.png"></a>
112+
&nbsp;&nbsp;&nbsp;
113+
<a href="https://www.netlify.com"><img align="center" width="150" src="https://cdn.netlify.com/15ecf59b59c9d04b88097c6b5d2c7e8a7d1302d0/1b6d6/img/press/logos/full-logo-light.svg"></a>
114+
<br>
115+
<br>
116+
<sub>GitHub allows us to host the Git repository, Netlify allows us to distribute the documentation.</sub>
117+
<br>
118+
<br>
119+
<a href="https://crowdin.com"><img align="center" width="180" src="https://support.crowdin.com/assets/logos/crowdin-logo1-small.png"></a>
120+
<br>
121+
<br>
114122
<sub>Crowdin allows us to translate conveniently the documentation.</sub>
115-
</p>
116-
117-
<p align="center"><a href="https://codacy.com"><img align="center" width="155" src="https://user-images.githubusercontent.com/16944225/55026017-623f8f00-5002-11e9-88bf-0d6a5884c6c2.png"></a>
118-
&nbsp;<a href="https://www.browserstack.com"><img align="center" width="140" src="https://www.browserstack.com/images/mail/browserstack-logo-footer.png"></a></p>
119-
<p align="center">
123+
<br>
124+
<br>
125+
<a href="https://codacy.com"><img align="center" width="155" src="https://user-images.githubusercontent.com/16944225/55026017-623f8f00-5002-11e9-88bf-0d6a5884c6c2.png"></a>
126+
&nbsp;&nbsp;&nbsp;
127+
<a href="https://www.browserstack.com"><img align="center" width="140" src="https://www.browserstack.com/images/mail/browserstack-logo-footer.png"></a>
128+
<br>
129+
<br>
120130
<sub>Codacy allows us to run the test suite, BrowserStack allows us to test in real browsers.</sub>
121131
</p>
122132

123-
[browser-image]: https://img.shields.io/badge/browser-%20chrome%20%7C%20firefox%20%7C%20opera%20%7C%20safari%20%7C%20ie%20%3E%3D%209-lightgrey.svg
124-
[browser-url]: https://www.browserstack.com
125-
126133
[docs-installation-url]: https://github.com/theme-next/hexo-theme-next/blob/master/docs/INSTALLATION.md
127134
[docs-data-files-url]: https://github.com/theme-next/hexo-theme-next/blob/master/docs/DATA-FILES.md
128135
[docs-update-5-1-x-url]: https://github.com/theme-next/hexo-theme-next/blob/master/docs/UPDATE-FROM-5.1.X.md
129136

137+
[t-news-url]: https://t.me/theme_next_news
138+
[t-chat-url]: https://t.me/theme_next
139+
[gitter-url]: https://gitter.im/theme-next
140+
[riot-url]: https://riot.im/app/#/room/#theme-next:matrix.org
141+
[i18n-url]: https://i18n.theme-next.org
142+
130143
[awesome-next-url]: https://github.com/theme-next/awesome-next
131-
[stack-url]: https://stackoverflow.com/questions/tagged/theme-next
132144
[issues-bug-url]: https://github.com/theme-next/hexo-theme-next/issues/new?assignees=&labels=Bug&template=bug-report.md
133145
[issues-feat-url]: https://github.com/theme-next/hexo-theme-next/issues/new?assignees=&labels=Feature+Request&template=feature-request.md
134146
[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
135-
136-
[gitter-url]: https://gitter.im/theme-next
137-
[riot-url]: https://riot.im/app/#/room/#theme-next:matrix.org
138-
[t-chat-url]: https://t.me/theme_next
139-
[t-news-url]: https://t.me/theme_next_news
140-
141-
<!--[rel-image]: https://img.shields.io/github/release/theme-next/hexo-theme-next.svg-->
142-
<!--[rel-image]: https://badge.fury.io/gh/theme-next%2Fhexo-theme-next.svg-->
143-
<!--[mnt-image]: https://img.shields.io/maintenance/yes/2018.svg-->
144-
145-
<!--[download-latest-url]: https://github.com/theme-next/hexo-theme-next/archive/master.zip-->
146-
<!--[releases-latest-url]: https://github.com/theme-next/hexo-theme-next/releases/latest-->
147-
<!--[releases-url]: https://github.com/theme-next/hexo-theme-next/releases-->
148-
<!--[tags-url]: https://github.com/theme-next/hexo-theme-next/tags-->
149-
<!--[commits-url]: https://github.com/theme-next/hexo-theme-next/commits/master-->

docs/INSTALLATION.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@
33
<h2 align="center">Step 1 &rarr; Go to Hexo dir</h2>
44

55
Change dir to **Hexo root** directory. There must be `node_modules`, `source`, `themes` and other directories:
6-
```sh
7-
$ cd hexo
8-
$ ls
9-
_config.yml node_modules package.json public scaffolds source themes
10-
```
6+
7+
```sh
8+
$ cd hexo
9+
$ ls
10+
_config.yml node_modules package.json public scaffolds source themes
11+
```
1112

1213
<h2 align="center">Step 2 &rarr; Get NexT</h2>
1314

14-
<p align="center">Download theme from GitHub.</br>
15+
<p align="center">Download theme from GitHub.<br>
1516
There are <b>3 options</b> to do it, need to <b>choose only one</b> of them.</p>
1617

1718
### Option 1: Download [latest release version][releases-latest-url]

docs/UPDATE-FROM-5.1.X.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<h1 align="center">Update from NexT v5.1.x</h1>
22

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

55
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.
66
2. Most libraries under the `next/source/lib` directory was moved out to [external repos under NexT organization](https://github.com/theme-next).
@@ -13,7 +13,7 @@ So, i suggest to update from version 5 to version 6 in this way:
1313
1.2. Custom CSS styles what placed in `next/source/css/_custom/*` and `next/source/css/_variables/*` directories.\
1414
1.3. Custom layout styles what placed in `next/layout/_custom/*`.\
1515
1.4. Any another possible custom additions which can be finded by compare tools between repos.
16-
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.
16+
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.
1717
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.
1818
4. Update language configuration (For Chinese)
1919

docs/ru/INSTALLATION.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@
33
<h2 align="center">Шаг 1 &rarr; Идём в директорию Hexo</h2>
44

55
Меняем каталог на **корневой hexo**. Там должны находиться `node_modules`, `source`, `themes` и другие папки:
6-
```sh
7-
$ cd hexo
8-
$ ls
9-
_config.yml node_modules package.json public scaffolds source themes
10-
```
6+
7+
```sh
8+
$ cd hexo
9+
$ ls
10+
_config.yml node_modules package.json public scaffolds source themes
11+
```
1112

1213
<h2 align="center">Шаг 2 &rarr; Скачиваем NexT</h2>
1314

14-
<p align="center">Скачиваем тему с GitHub.</br>
15+
<p align="center">Скачиваем тему с GitHub.<br>
1516
Имеются <b>3 способа</b> как зделать это, нужно <b>выбрать только 1</b> из них.</p>
1617

1718
### Способ 1: Скачиваем [последнюю версию релиза][releases-latest-url]

0 commit comments

Comments
 (0)