This repository has been archived by the owner on May 27, 2023. It is now read-only.
forked from theme-next/hexo-theme-next
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
dbd3d93
commit a9aa84f
Showing
404 changed files
with
20,582 additions
and
9,128 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "directory": "source/lib" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| source/lib/* linguist-vendored | ||
| scripts/merge.js linguist-vendored |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,6 @@ | ||
| <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> | ||
|
|
||
|
|
@@ -14,8 +11,6 @@ First of all, thanks for taking your time to contribute and help make our projec | |
| [How Can I Contribute?](#how-can-i-contribute) | ||
|
|
||
| * [Before Submitting An Issue](#before-submitting-an-issue) | ||
| * [Read the docs](#read-the-docs) | ||
| * [Quick debug instructions](quick-debug-instructions) | ||
| * [Reporting Bugs](#reporting-bugs) | ||
| * [Reporting Security Bugs](#reporting-security-bugs) | ||
| * [Suggesting Enhancements](#suggesting-enhancements) | ||
|
|
@@ -29,30 +24,25 @@ First of all, thanks for taking your time to contribute and help make our projec | |
| * [Labels Rules](#labels-rules) | ||
| * [Commit Messages Rules](#commit-messages-rules) | ||
|
|
||
| ## How Can I Contribute? | ||
|
|
||
| ### Before Submitting An Issue | ||
| <a name="how-can-i-contribute"></a> | ||
|
|
||
| #### Read the docs | ||
| ## How Can I Contribute? | ||
|
|
||
| If you just have a question, you'll get faster results by checking the [FAQs for a list of common questions and problems](https://theme-next.org/docs/faqs) or the [troubleshooting part of «NexT» Documentation Site](https://theme-next.org/docs/troubleshooting). | ||
| Main Theme-Next repository was rebased from [iissnan's](https://github.com/iissnan/hexo-theme-next) profile to [Theme-Next](https://github.com/theme-next) organization on GitHub. Most libraries under the `next/source/lib` directory was moved out to [external repos](https://github.com/theme-next) under NexT organization. Version 5 works fine at most cases, but for frequent users, you maybe need to [upgrade version 5 to 6](https://github.com/theme-next/hexo-theme-next/blob/master/docs/UPDATE-FROM-5.1.X.md) to get features and supports in new [Theme-Next](https://github.com/theme-next/hexo-theme-next) repository. | ||
|
|
||
| Also, you can perform a [cursory search](https://github.com/theme-next/hexo-theme-next/search?q=&type=Issues&utf8=%E2%9C%93) to see if the problem has already been reported or solved. You don't want to duplicate effort. You might be able to find the cause of the problem and fix things yourself, or add comments to the existed issue. | ||
| <a name="before-submitting-an-issue"></a> | ||
|
|
||
| #### Quick debug instructions | ||
| ### Before Submitting An Issue | ||
|
|
||
| Before submitting an Issue on GitHub, you can follow the steps below to debug: | ||
| If you just have a question, you'll get faster results by checking the FAQs for a list of common questions and problems (Work in progress) or the [«NexT» Documentation Site](https://theme-next.org/docs/) (Work in progress). | ||
|
|
||
| * Execute `hexo clean`, clear the browser cache and disable all CDN services (e.g. Cloudflare Rocket Loader) | ||
| * Switch to another theme and check if the bug still exists (e.g. default theme landscape). In other words, prove that this is a NexT issue, not a issue from Hexo. | ||
| * Upgrade theme NexT to the latest version. | ||
| * Upgrade Hexo and Hexo plugins to the latest version. | ||
| * Upgrade Node.js and `npm` to the latest version. | ||
| * Uninstall all non-essential Hexo plugins, or reinstall all plugins using `npm install --save`. | ||
| Also, you can perform a [cursory search](https://github.com/theme-next/hexo-theme-next/search?q=&type=Issues&utf8=%E2%9C%93) to see if the problem has already been reported or solved. You don't want to duplicate effort. You might be able to find the cause of the problem and fix things yourself, or add comments to the existed issue. | ||
|
|
||
| If you get an error message from Hexo or your browser, please search in Google / Stackoverflow / GitHub Issues, or report it to us when submitting a new Issue. | ||
| If you find a bug in the source code, most importantly, please check carefully if you can reproduce the problem [in the latest release version of Next](https://github.com/theme-next/hexo-theme-next/releases/latest). Then, you can help us by | ||
| [Reporting Bugs](#reporting-bugs) or [Suggesting Enhancements](#suggesting-enhancements) to our [ Repository](https://github.com/theme-next/hexo-theme-next). Even better, you can | ||
| [submit a Pull Request](#submitting-a-pull-request) with a fix. | ||
|
|
||
| If you find a bug in the source code, most importantly, please check carefully if you can reproduce the problem [in the latest release version of Next](https://github.com/theme-next/hexo-theme-next/releases/latest). Then, you can help us by [Reporting Bugs](#reporting-bugs) or [Suggesting Enhancements](#suggesting-enhancements) to our [Repository](https://github.com/theme-next/hexo-theme-next). Even better, you can [submit a Pull Request](#submitting-a-pull-request) with a fix. | ||
| <a name="reporting-bugs"></a> | ||
|
|
||
| ### Reporting Bugs | ||
|
|
||
|
|
@@ -72,12 +62,16 @@ Following these guidelines helps maintainers and the community understand your r | |
| * Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior. | ||
| * Explain which behavior you expected to see instead and why. | ||
|
|
||
| <a name="reporting-security-bugs"></a> | ||
|
|
||
| #### Reporting Security Bugs | ||
|
|
||
| If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited. Please send the related information to [email protected] (desirable with using PGP for e-mail encryption). | ||
|
|
||
| We will gladly special thanks to anyone who reports a vulnerability so that we can fix it. If you want to remain anonymous or pseudonymous instead, please let us know that; we will gladly respect your wishes. | ||
|
|
||
| <a name="suggesting-enhancements"></a> | ||
|
|
||
| ### Suggesting Enhancements | ||
|
|
||
| Before creating enhancement suggestions, please check [this list](#before-submitting-an-issue) as you might find out that you don't need to create one. After you've determined the repository your enhancement suggestion is related to, create an issue on that repository and provide the information as many details as possible by filling in [the required template](ISSUE_TEMPLATE.md). | ||
|
|
@@ -88,17 +82,39 @@ Following these guidelines helps maintainers and the community understand your s | |
| * Describe the current behavior and explain which behavior you expected to see instead and Explain why this enhancement would be useful to most users. | ||
| * Provide specific examples to demonstrate the suggestion. Include links to files (screenshots or GIFs) or live demo. | ||
|
|
||
| <a name="submitting-a-pull-request"></a> | ||
|
|
||
| ### Submitting a Pull Request | ||
|
|
||
| Before creating a Pull Request (PR), please check [this list](#before-submitting-an-issue) as you might find out that you don't need to create one. After you've determined the repository your pull request is related to, create a pull request on that repository. The detailed document of creating a pull request can be found [here](https://help.github.com/articles/creating-a-pull-request/). | ||
|
|
||
| 1. On GitHub, navigate to the original page of the [hexo-theme-next](https://github.com/theme-next/hexo-theme-next). In the top-right corner of the page, click **Fork**. | ||
| 2. Under the repository name in your forked repository, click **Clone or download**. In the `Clone with SSH` section, copy the clone URL for the repository. Open Git Bash, and change the current working directory to the location where you want the cloned directory to be made. Type `git clone`, and then paste the URL you copied. Press **Enter**. Your local clone will be created. | ||
| ```bash | ||
| $ git clone [email protected]:username/hexo-theme-next.git | ||
| ``` | ||
| 3. Navigate into your new cloned repository. Switch branches to the compare branch of the pull request where the original changes were made. | ||
| ```bash | ||
| $ cd hexo-theme-next | ||
| $ git checkout -b patchname | ||
| ``` | ||
| 4. After you commit your changes to the head branch of the pull request you can push your changes up to the original pull request directly. | ||
| ```bash | ||
| $ git add . | ||
| $ git commit -m "add commit messamge" | ||
| $ git push origin patchname | ||
| ``` | ||
| 5. Navigate to the original repository you created your fork from. To the right of the Branch menu, click **New pull request**. On the Compare page, confirm that the base fork is the repository you'd like to merge changes into. Use the base branch drop-down menu to select the branch of the upstream repository you'd like to merge changes into. Use the head fork drop-down menu to select your fork, then use the compare branch drop-down menu to select the branch you made your changes in. Click **Create pull request** and type a title and description for your pull request. | ||
|
|
||
| Following these guidelines helps maintainers and the community understand your pull request :pencil:: | ||
|
|
||
| * Follow our [Coding Rules](#coding-rules) and [commit message conventions](#commit-messages-rules). | ||
| * Use a clear and descriptive title for the issue to identify the pull request. Do not include issue numbers in the PR title. | ||
| * Fill in [the required template](PULL_REQUEST_TEMPLATE.md) as many details as possible. | ||
| * All features or bug fixes must be tested in all schemes. And provide specific examples to demonstrate the pull request. Include links to files (screenshots or GIFs) or live demo. | ||
|
|
||
| <a name="creating-releases"></a> | ||
|
|
||
| ### Creating Releases | ||
|
|
||
| Releases are a great way to ship projects on GitHub to your users. | ||
|
|
@@ -114,67 +130,85 @@ Releases are a great way to ship projects on GitHub to your users. | |
| 5. If you'd like to include binary files along with your release, such as compiled programs, drag and drop or select files manually in the binaries box. | ||
| 6. If the release is unstable, select **This is a pre-release** to notify users that it's not ready for production. If you're ready to publicize your release, click **Publish release**. Otherwise, click **Save draft** to work on it later. | ||
| <a name="guides"></a> | ||
| ## Guides | ||
| <a name="coding-rules"></a> | ||
| ### Coding Rules | ||
| This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md) to keep open and inclusive. By participating, you are expected to uphold this code. | ||
| <a name="coding-standards"></a> | ||
| ### Coding Standards | ||
| We use ESLint and Stylint for identifying and reporting on patterns in JavaScript and Stylus, with the goal of making code more consistent and avoiding bugs. These specifications should be followed when coding. | ||
| To be continued. | ||
| <a name="labels-rules"></a> | ||
| ### Labels Rules | ||
| We use "labels" in the issue tracker to help classify Pull requests and Issues. Using labels enables maintainers and users to quickly find issues they should look into, either because they experience them, or because it meets their area of expertise. | ||
| If you are unsure what a label is about or which labels you should apply to a PR or issue, look no further! | ||
| Issues related: | ||
| Issues related: `types`+`contents`+`results` | ||
| - By types | ||
| - `Irrelevant`: An irrelevant issue for Next | ||
| - `Duplicate`: An issue which had been mentioned | ||
| - `Bug`: A detected bug that needs to be confirmed | ||
| - `Improvement Need`: An issue that needs improvement | ||
| - `Feature Request`: An issue that wants a new feature | ||
| - `High Priority`: A detected bug or misprint with high priority | ||
| - `Low Priority`: A detected bug or misprint with low priority | ||
| - `Non English`: Requires the attention of a multi-lingual maintainer | ||
| - `Discussion`: An issue that needs to be discussed | ||
| - `Question`: An issue about questions | ||
| - `Backlog`: An issue that is to be completed and later compensated | ||
| - `Meta`: Denoting a change of usage conditions | ||
| - `Support`: An issue labeled as support requests | ||
| - `Polls`: An issue that initiated a poll | ||
| - By contents | ||
| - `Roadmap`: An issue about future development | ||
| - `Hexo`: An issue related to Hexo | ||
| - `Scheme [1] - Mist`: An issue related to Scheme Mist | ||
| - `Scheme [2] - Muse`: An issue related to Scheme Muse | ||
| - `Scheme [3] - Pisces`: An issue related to Scheme Pisces | ||
| - `Scheme [4] - Gemini`: An issue related to Scheme Gemini | ||
| - `3rd Party Service`: An issue related to 3rd party service | ||
| - `Docs`: Need to add instruction document | ||
| - `Configurations`: An issue related to configurations | ||
| - `CSS`: An issue related to CSS | ||
| - `Custom`: An issue related to custom things | ||
| - By results | ||
| - `Duplicate`: An issue which had been mentioned | ||
| - `Irrelevant`: An irrelevant issue for Next | ||
| - `Invalid`: An issue that cannot be reproduced | ||
| - `Expected Behavior`: An issue that corresponds to expected behavior | ||
| - `Wontfix`: An issue that will not to be fixed | ||
| - `Need More Info`: Need more information for solving the issue | ||
| - `Need Verify`: Need confirmation from the developers or user about the bug or solution | ||
| - `Can't Reproduce`: An issue that can’t be reproduced | ||
| - `Verified`: An issue that has been verified | ||
| - `Help Wanted`: An issue that needs help | ||
| - `Wait for Answer`: An issue that needs to be answered by the developers or user | ||
| - `Resolved Maybe`: An issue that has been resolved maybe | ||
| - `Solved`: An issue that has been solved | ||
| - `Backlog`: An issue that is to be completed and later compensated | ||
| - `Stale`: This issue has been automatically marked as stale because lack of recent activity | ||
| Pull requests related: | ||
| - `Breaking Change`: A pull request that makes breaking change | ||
| - `External Change`: A pull request that makes update for external change | ||
| - `Bug Fix`: A pull request that fixes the related bug | ||
| - `Docs`: A pull request that Instruction document has been added | ||
| - `New Feature`: A pull request that provides a new feature | ||
| - `Feature`: A pull request that provides an option or addition to existing feature | ||
| - `Improvement`: A pull request that improves NexT | ||
| - `i18n`: A pull request that makes new languages translation | ||
| - `Work in Progress`: A pull request that is still working in progress | ||
| - `Skip Release`: A pull request that should be excluded from release note | ||
|
|
||
| Both: | ||
|
|
||
| - `Roadmap`: An issue / pull request about future development | ||
| - `Help Wanted`: An issue / pull request that needs help | ||
| - `Discussion`: An issue / pull request that needs to be discussed | ||
| - `Improvement`: An issue that needs improvement or a pull request that improves NexT | ||
| - `Performance`: An issue / pull request that improves the performance | ||
| - `Hexo`: An issue / pull request related to Hexo or Hexo plugins | ||
| - `Template Engine`: An issue / pull request related to template engine | ||
| - `CSS`: An issue / pull request related to CSS | ||
| - `Fonts`: An issue / pull request related to fonts | ||
| - `PJAX`: An issue / pull request related to PJAX | ||
| - `3rd Party Plugin`: An issue / pull request related to 3rd party plugins & service | ||
| - `Docs`: An issue / pull request related to instruction document | ||
| - `Configurations`: An issue / pull request related to configurations | ||
| - `Performance`: A pull request that improves the performance | ||
| - `Discussion`: A pull request that needs to be discussed | ||
| - `v6.x`: A pull request that bug fixes and some improvements, related to old NexT version 6 | ||
| - `v7.x`: A pull request that bug fixes and some improvements, related to old NexT version 7 | ||
| <a name="commit-messages-rules"></a> | ||
| ### Commit Messages Rules | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| <!-- ATTENTION! | ||
| IF YOU DON'T FILL OUT THE FOLLOWING INFORMATION WE MIGHT CLOSE YOUR ISSUE WITHOUT INVESTIGATING. | ||
| 如果你不填充下面的内容，我们可能会直接关闭你的 issue。 | ||
| If you want to fast resolve your issue, WRITE IT IN ENGLISH, please. Not all contributors/collaborators know Chinese language and Google translate can't always give true translates on issues. Thanks! | ||
| You may delete this recomendations and use template which is placed below. | ||
| --> | ||
|
|
||
| ### I agree and want to create new issue <!-- (我确认我已经查看了) --> | ||
|
|
||
| <!-- Check all with [x] (把 [ ] 换成 [X] 来选择) --> | ||
| - [ ] Yes, I was on [Hexo Docs page](https://hexo.io/docs/), especially on [Templates](https://hexo.io/docs/templates.html), [Variables](https://hexo.io/docs/variables.html), [Helpers](https://hexo.io/docs/helpers.html) and [Troubleshooting](https://hexo.io/docs/troubleshooting.html). | ||
| - [ ] Yes, I was on [NexT Documentation Site](http://theme-next.org/docs/). | ||
| - [ ] And yes, I already searched for current [issues](https://github.com/theme-next/hexo-theme-next/issues?utf8=%E2%9C%93&q=is%3Aissue) and this is not help to me. | ||
|
|
||
| *** | ||
|
|
||
| ### Expected behavior <!-- (预期行为) --> | ||
|
|
||
|
|
||
| ### Actual behavior <!-- (实际行为) --> | ||
|
|
||
|
|
||
| ### Steps to reproduce the behavior <!-- (重现步骤) --> | ||
| 1. N/A | ||
| 2. N/A | ||
| 3. N/A | ||
|
|
||
| * Link to demo site with this issue: N/A | ||
| * Link(s) to source code or any usefull link(s): N/A | ||
|
|
||
| ### Node.js and NPM Information | ||
| <!-- Paste output from `node -v && npm -v` (粘贴 `node -v && npm -v` 输出的信息) --> | ||
| ``` | ||
| ``` | ||
|
|
||
| ### Package dependencies Information | ||
| <!-- Paste output from `cat package.json` (粘贴 `cat package.json` 输出的信息) --> | ||
| ``` | ||
| ``` | ||
|
|
||
| ### Hexo Information | ||
|
|
||
| #### Hexo version | ||
| <!-- Paste output from `hexo -v` (粘贴 `hexo -v` 输出的信息) --> | ||
| ``` | ||
| ``` | ||
|
|
||
| #### Hexo Configuration | ||
| <!-- Paste configuration from Hexo `_config.yml` (从 Hexo `_config.yml` 中粘贴信息) --> | ||
| ```yml | ||
|
|
||
| ``` | ||
|
|
||
| ### NexT Information | ||
|
|
||
| **NexT Version:** | ||
| <!-- Check needed with [x] (把 [ ] 换成 [X] 来选择) --> | ||
|
|
||
| - [ ] Latest Master branch | ||
| - [ ] Latest Release version | ||
| - [ ] Old version | ||
|
|
||
|
|
||
| **NexT Scheme:** | ||
| <!-- Check needed with [x] (把 [ ] 换成 [X] 来选择) --> | ||
|
|
||
| - [ ] All schemes | ||
| - [ ] Muse | ||
| - [ ] Mist | ||
| - [ ] Pisces | ||
| - [ ] Gemini | ||
|
|
||
|
|
||
| #### NexT Configuration: | ||
| <!-- Paste ONLY CHANGED CONFIGURATION from NexT `_config.yml` (只粘贴NexT主题配置文件 `_config.yml` 中修改过的部分) --> | ||
| ```yml | ||
|
|
||
| ``` | ||
|
|
||
| ### Other Information <!-- (Like Browser, System, Screenshots) --> |
Oops, something went wrong.