Back to Handycontrol

e x T

doc/themes/next/README.md

3.5.229.6 KB
Original Source
<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"></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"></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"></a> <a href="https://travis-ci.org/theme-next/hexo-theme-next?branch=master"></a> <a href="https://i18n.theme-next.org"></a> <a href="https://github.com/theme-next/hexo-theme-next/releases"></a> <a href="http://hexo.io"></a> <a href="https://github.com/theme-next/hexo-theme-next/blob/master/LICENSE.md"></a> </p>

Live Preview

More «NexT» examples here.

Installation

Simplest way to install is by cloning the entire repository:

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

Or you can see detailed installation instructions 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.

For example, if you want to use fancybox in your site, go to NexT config and see:

yml
# Fancybox
# Dependencies: https://github.com/theme-next/theme-next-fancybox
fancybox: false

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

Exceptions

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

For example, if you want to use fancybox and you configured a cdn link, go to NexT config and see:

yml
vendors:
  # ...
  # Some contents...
  # ...
  fancybox: # Set or update fancybox cdn url.
  fancybox_css: # Set or update fancybox cdn url.

Instead of defining main organization link for updates.

Update

You can update to latest master branch by the following command:

sh
$ cd themes/next
$ 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 feature.
However, you can bypass update errors by using the Commit, Stash or Reset commands for local changes. See here how to do it.

If you want to update from v5.1.x to v6.0.x, read here.

Known Bugs

For those who also encounter «Error: Cannot find module 'hexo-util'», please check your NPM version.

  • > 3: Still not work? Please remove node_modules directory and reinstall using npm install.
  • < 3: Please add hexo-util explicitly via npm install --save-dev hexo-util to you site package deps.

Contributing

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

Feedback

Third party applications

  • :triangular_flag_on_post: <a title="Hexo Markdown Editor" href="https://github.com/zhuzhuyule/HexoEditor" target="_blank">HexoEditor</a>

Thanks

<p align="center"> «NexT» send special thanks to these great services that sponsor our core infrastructure: </p> <p align="center"><a href="https://github.com"></a> &nbsp;<a href="https://www.netlify.com"></a></p> <p align="center"> <sub>GitHub allows us to host the Git repository, Netlify allows us to distribute the documentation.</sub> </p> <p align="center"><a href="https://crowdin.com"></a></p> <p align="center"> <sub>Crowdin allows us to translate conveniently the documentation.</sub> </p> <p align="center"><a href="https://codacy.com"></a> &nbsp;<a href="https://www.browserstack.com"></a></p> <p align="center"> <sub>Codacy allows us to run the test suite, BrowserStack allows us to test in real browsers.</sub> </p> <!--[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--> <!--[releases-url]: https://github.com/theme-next/hexo-theme-next/releases-->

Contributors

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore --> <table><tr><td align="center"><a href="https://almostover.ru"> <sub><b>Ivan.Nginx</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Aivan-nginx" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=ivan-nginx" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=ivan-nginx" title="Documentation">📖</a> <a href="#ideas-ivan-nginx" title="Ideas, Planning, & Feedback">🤔</a> <a href="#blog-ivan-nginx" title="Blogposts">📝</a> <a href="#review-ivan-nginx" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=ivan-nginx" title="Tests">⚠️</a> <a href="#translation-ivan-nginx" title="Translation">🌍</a> <a href="#design-ivan-nginx" title="Design">🎨</a> <a href="#infra-ivan-nginx" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-ivan-nginx" title="Maintenance">🚧</a></td><td align="center"><a href="http://saili.science"> <sub><b>Alex LEE</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Asli1989" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=sli1989" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=sli1989" title="Documentation">📖</a> <a href="#review-sli1989" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=sli1989" title="Tests">⚠️</a> <a href="#translation-sli1989" title="Translation">🌍</a></td><td align="center"><a href="https://tsanie.us"> <sub><b>Tsanie Lily</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Atsanie" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=tsanie" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=tsanie" title="Documentation">📖</a> <a href="#review-tsanie" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=tsanie" title="Tests">⚠️</a> <a href="#translation-tsanie" title="Translation">🌍</a></td><td align="center"><a href="https://wafer.li"> <sub><b>Wafer Li</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Awafer-li" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=wafer-li" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=wafer-li" title="Documentation">📖</a> <a href="#review-wafer-li" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=wafer-li" title="Tests">⚠️</a> <a href="#translation-wafer-li" title="Translation">🌍</a></td><td align="center"><a href="https://leaferx.online"> <sub><b>Lawrence Ye</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3ALEAFERx" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=LEAFERx" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=LEAFERx" title="Documentation">📖</a> <a href="#review-LEAFERx" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=LEAFERx" title="Tests">⚠️</a> <a href="#translation-LEAFERx" title="Translation">🌍</a></td><td align="center"><a href="https://blog.maple3142.net/"> <sub><b>maple</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Amaple3142" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=maple3142" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=maple3142" title="Documentation">📖</a> <a href="#review-maple3142" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=maple3142" title="Tests">⚠️</a> <a href="#translation-maple3142" title="Translation">🌍</a></td><td align="center"><a href="https://raincal.com"> <sub><b>Raincal</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3ARaincal" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=Raincal" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=Raincal" title="Documentation">📖</a> <a href="#review-Raincal" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=Raincal" title="Tests">⚠️</a></td></tr><tr><td align="center"><a href="https://rainylog.com"> <sub><b>Rainy</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Ageekrainy" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=geekrainy" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=geekrainy" title="Documentation">📖</a> <a href="#review-geekrainy" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=geekrainy" title="Tests">⚠️</a> <a href="#translation-geekrainy" title="Translation">🌍</a></td><td align="center"><a href="https://liolok.github.io/"> <sub><b>李皓奇</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Aliolok" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=liolok" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=liolok" title="Documentation">📖</a> <a href="#review-liolok" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=liolok" title="Tests">⚠️</a></td><td align="center"><a href="http://ioliu.cn"> <sub><b>Nine</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3AxCss" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=xCss" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=xCss" title="Documentation">📖</a> <a href="#review-xCss" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=xCss" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/jackey8616"> <sub><b>Clooooode</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Ajackey8616" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=jackey8616" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=jackey8616" title="Documentation">📖</a></td><td align="center"><a href="https://github.com/xu-song"> <sub><b>Xu Song</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Axu-song" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=xu-song" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=xu-song" title="Documentation">📖</a></td><td align="center"><a href="https://github.com/HuntedCodes"> <sub><b>Jack Sullivan</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3AHuntedCodes" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=HuntedCodes" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=HuntedCodes" title="Documentation">📖</a></td><td align="center"><a href="https://github.com/dpyzo0o"> <sub><b>dpyzo0o</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Adpyzo0o" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=dpyzo0o" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=dpyzo0o" title="Documentation">📖</a></td></tr><tr><td align="center"><a href="http://zhuzhuyule.com"> <sub><b>zhuzhuxia</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Azhuzhuyule" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=zhuzhuyule" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=zhuzhuyule" title="Documentation">📖</a></td><td align="center"><a href="https://kuleyu-hugo.netlify.com/"> <sub><b>kuleyu</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Akuleyu" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=kuleyu" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=kuleyu" title="Documentation">📖</a></td><td align="center"><a href="http://jdhao.github.io"> <sub><b>jdhao</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Ajdhao" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=jdhao" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=jdhao" title="Documentation">📖</a></td><td align="center"><a href="http://www.albertgao.xyz"> <sub><b>AlbertGao</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3AAlbert-Gao" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=Albert-Gao" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=Albert-Gao" title="Documentation">📖</a></td><td align="center"><a href="https://yoshinorin.net/"> <sub><b>YoshinoriN</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3AYoshinoriN" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=YoshinoriN" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=YoshinoriN" title="Documentation">📖</a></td><td align="center"><a href="https://zhaoqi99.github.io/"> <sub><b>Qi Zhao</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3AZhaoQi99" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=ZhaoQi99" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=ZhaoQi99" title="Documentation">📖</a></td><td align="center"><a href="https://changchen.me/"> <sub><b>Henry Zhu</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Adaya0576" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=daya0576" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=daya0576" title="Documentation">📖</a></td></tr><tr><td align="center"><a href="https://github.com/cxyfreedom"> <sub><b>CxyFreedom</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Acxyfreedom" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=cxyfreedom" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=cxyfreedom" title="Documentation">📖</a></td><td align="center"><a href="https://kaitohh.com/"> <sub><b>KaitoHH</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3AKaitoHH" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=KaitoHH" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=KaitoHH" title="Documentation">📖</a></td><td align="center"><a href="http://www.zhaojun.im"> <sub><b>赵俊</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Azhaojun1998" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=zhaojun1998" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=zhaojun1998" title="Documentation">📖</a></td><td align="center"><a href="https://github.com/izyhang"> <sub><b>zyhang</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Aizyhang" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=izyhang" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=izyhang" title="Documentation">📖</a></td><td align="center"><a href="https://xiaolony.github.io"> <sub><b>Xiaolong Yang</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3AXiaolonY" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=XiaolonY" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=XiaolonY" title="Documentation">📖</a></td><td align="center"><a href="https://github.com/yzca"> <sub><b>花蛄</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Ayzca" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=yzca" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=yzca" title="Documentation">📖</a></td><td align="center"><a href="http://hengyunabc.github.io/"> <sub><b>hengyunabc</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Ahengyunabc" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=hengyunabc" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=hengyunabc" title="Documentation">📖</a></td></tr><tr><td align="center"><a href="http://bluefisher.github.io"> <sub><b>Fisher Chang</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3ABlueFisher" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=BlueFisher" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=BlueFisher" title="Documentation">📖</a></td><td align="center"><a href="http://chansonshen.com/"> <sub><b>Chanson Shen</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Ashenchsh" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=shenchsh" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=shenchsh" title="Documentation">📖</a></td><td align="center"><a href="http://ywjno.com"> <sub><b>Thomas Yang</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Aywjno" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=ywjno" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=ywjno" title="Documentation">📖</a></td><td align="center"><a href="http://legendarynacar.github.io"> <sub><b>Legendary Nacar</b></sub></a> <a href="#translation-legendarynacar" title="Translation">🌍</a></td><td align="center"><a href="https://github.com/Rikusen0335"> <sub><b>rikusen0335</b></sub></a> <a href="#translation-Rikusen0335" title="Translation">🌍</a></td><td align="center"><a href="https://www.dnocm.com"> <sub><b>Mr.J</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3AJiangTJ" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=JiangTJ" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=JiangTJ" title="Documentation">📖</a> <a href="#infra-JiangTJ" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td><td align="center"><a href="https://1v9.im"> <sub><b>1v9</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3A1v9" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=1v9" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=1v9" title="Documentation">📖</a> <a href="#translation-1v9" title="Translation">🌍</a> <a href="#review-1v9" title="Reviewed Pull Requests">👀</a></td></tr><tr><td align="center"><a href="https://zhangshuqiao.org"> <sub><b>Mimi</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Astevenjoezhang" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=stevenjoezhang" title="Code">💻</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=stevenjoezhang" title="Documentation">📖</a> <a href="#review-stevenjoezhang" title="Reviewed Pull Requests">👀</a> <a href="#translation-stevenjoezhang" title="Translation">🌍</a></td><td align="center"><a href="https://i-m.dev"> <sub><b>张强</b></sub></a> <a href="https://github.com/theme-next/hexo-theme-next/issues?q=author%3Azq-97" title="Bug reports">🐛</a> <a href="https://github.com/theme-next/hexo-theme-next/commits?author=zq-97" title="Code">💻</a></td></tr></table> <!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the all-contributors specification. Contributions of any kind welcome!