Skip to content

Commit

Permalink
New README for NexT (theme-next#1155)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ivan-nginx @stevenjoezhang
ivan-nginx authored and stevenjoezhang committed Oct 7, 2019
1 parent a532782 commit c5aa9b7
Show file tree
Hide file tree
Showing 14 changed files with 238 additions and 244 deletions.
9 changes: 6 additions & 3 deletions .github/CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<div align="right">Language: :us:
<a title="Chinese" href="../docs/zh-CN/CODE_OF_CONDUCT.md">:cn:</a>
<a title="Russian" href="../docs/ru/CODE_OF_CONDUCT.md">:ru:</a></div>
<div align="right">
Language:
:us:
<a title="Chinese" href="../docs/zh-CN/CODE_OF_CONDUCT.md">:cn:</a>
<a title="Russian" href="../docs/ru/CODE_OF_CONDUCT.md">:ru:</a>
</div>

# <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>

Expand Down
9 changes: 6 additions & 3 deletions .github/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<div align="right">Language: :us:
<a title="Chinese" href="../docs/zh-CN/CONTRIBUTING.md">:cn:</a>
<a title="Russian" href="../docs/ru/CONTRIBUTING.md">:ru:</a></div>
<div align="right">
Language:
:us:
<a title="Chinese" href="../docs/zh-CN/CONTRIBUTING.md">:cn:</a>
<a title="Russian" href="../docs/ru/CONTRIBUTING.md">:ru:</a>
</div>

# <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>

Expand Down
3 changes: 0 additions & 3 deletions .travis.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ cache:

install: npm install

before_script:
- npm install -g gulp

addons:
browserstack:
username: "ivannginx1"
Expand Down
131 changes: 64 additions & 67 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,49 +1,54 @@
<div align="right">Language: :us:
<a title="Chinese" href="docs/zh-CN/README.md">:cn:</a>
<a title="Russian" href="docs/ru/README.md">:ru:</a></div>
<div align="right">
Language:
:us:
<a title="Chinese" href="docs/zh-CN/README.md">:cn:</a>
<a title="Russian" href="docs/ru/README.md">:ru:</a>
</div>

# <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>

<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>

<p align="center">
<a href="https://bestpractices.coreinfrastructure.org/projects/2625"><img src="https://bestpractices.coreinfrastructure.org/projects/2625/badge" title="Core Infrastructure Initiative Best Practices"></a>
<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>
<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>
<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>
<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>
<a href="http://hexo.io"><img src="https://img.shields.io/badge/hexo-%3E%3D%203.5.0-blue.svg"></a>
<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>
</p>

<p align="center">
«NexT» is a high quality elegant <a href="https://hexo.io">Hexo</a> theme. It is crafted from scratch with love.
<br>
<br>
<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>
<a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E=8.6.0-green?style=flat-square"></a>
<a href="https://hexo.io"><img src="https://img.shields.io/badge/hexo-%3E=3.5.0-blue?style=flat-square&logo=hexo"></a>
<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>
<br>
<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>
<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>
<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>
<img src="https://img.shields.io/snyk/vulnerabilities/github/theme-next/hexo-theme-next?style=flat-square" title="Vulnerabilities">
<br>
<img src="https://user-images.githubusercontent.com/16272760/63487983-da41b080-c4df-11e9-951c-64883a8a5e9b.png">
</p>

## Live Preview

<p align="center">
: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>
: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>
<br>
<br>
More «NexT» examples <a href="https://github.com/theme-next/awesome-next#live-preview">here</a>.
</p>

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

## 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.

## Plugins

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).

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

```yml
# Easily enable fast Ajax navigation on your website.
Expand All @@ -53,7 +58,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 @@ -81,69 +86,61 @@ $ 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 [here][docs-update-5-1-x-url].**

## Contributing

Contribution is welcome, feel free to open an issue and fork. Waiting for your pull request.
**If you want to update from v5.1.x to the latest version, read [this][docs-update-5-1-x-url].**

## Feedback

* Follow us with [Telegram Channel][t-news-url] for latest news.
* Join our [Telegram][t-chat-url] / [Gitter][gitter-url] / [Riot][riot-url] chats.
* [Add or improve translation][i18n-url] in few seconds.
* 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.

## Thanks
## Contributing

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

<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>
&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>
<p align="center">
<sub>GitHub allows us to host the Git repository, Netlify allows us to distribute the documentation.</sub>
</p>
## Thanks

<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>
<p align="center">
«NexT» send special thanks to these great services that sponsor our core infrastructure:
<br>
<br>
<a href="https://github.com"><img align="center" width="100" src="https://github.githubassets.com/images/modules/logos_page/GitHub-Logo.png"></a>
&nbsp;&nbsp;&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>
<br>
<br>
<sub>GitHub allows us to host the Git repository, Netlify allows us to distribute the documentation.</sub>
<br>
<br>
<a href="https://crowdin.com"><img align="center" width="180" src="https://support.crowdin.com/assets/logos/crowdin-logo1-small.png"></a>
<br>
<br>
<sub>Crowdin allows us to translate conveniently the documentation.</sub>
</p>

<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>
&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>
<p align="center">
<br>
<br>
<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>
&nbsp;&nbsp;&nbsp;
<a href="https://www.browserstack.com"><img align="center" width="140" src="https://www.browserstack.com/images/mail/browserstack-logo-footer.png"></a>
<br>
<br>
<sub>Codacy allows us to run the test suite, BrowserStack allows us to test in real browsers.</sub>
</p>

[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
[browser-url]: https://www.browserstack.com

[docs-installation-url]: https://github.com/theme-next/hexo-theme-next/blob/master/docs/INSTALLATION.md
[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

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

[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-->

<!--[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-->
13 changes: 7 additions & 6 deletions docs/INSTALLATION.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@
<h2 align="center">Step 1 &rarr; Go to Hexo dir</h2>

Change dir to **Hexo root** directory. There must be `node_modules`, `source`, `themes` and other directories:
```sh
$ cd hexo
$ ls
_config.yml node_modules package.json public scaffolds source themes
```

```sh
$ cd hexo
$ ls
_config.yml node_modules package.json public scaffolds source themes
```

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

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

### Option 1: Download [latest release version][releases-latest-url]
Expand Down
4 changes: 2 additions & 2 deletions docs/UPDATE-FROM-5.1.X.md
View file
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
13 changes: 7 additions & 6 deletions docs/ru/INSTALLATION.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@
<h2 align="center">Шаг 1 &rarr; Идём в директорию Hexo</h2>

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

```sh
$ cd hexo
$ ls
_config.yml node_modules package.json public scaffolds source themes
```

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

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

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

0 comments on commit c5aa9b7

Please sign in to comment.