0%

Troubleshooting

Quick Debug Instructions

Before submitting an Issue on GitHub, you can follow the steps below to debug:

If you get an error message from Hexo or your browser:

  • If the error comes from a Hexo plugin, such as hexo-enhancer, please submit an Issue to its GitHub repository.
  • If the error comes from a third-party service, such as the Gitalk comment system, please submit an Issue to its GitHub repository.
  • Otherise, please search in Google / Stackoverflow / GitHub Issues, or report it to us when submitting a new Issue.

The following steps will help you determine the cause of the problem:

  • Execute hexo clean, clear the browser cache and disable all CDN services (e.g. Cloudflare Rocket Loader) - This may take some time to take effect.
  • Disable browser plug-ins or use other devices and browsers to test, because bugs may only occur in specific browsers.
  • Switch to another theme and check if the bug still exists (e.g. default theme landscape). In other words, prove that this is a bug of NexT, not Hexo.
  • Upgrade theme NexT to the latest version.
  • Upgrade Hexo and all Hexo plugins to the latest version.
  • Upgrade or downgrade Node.js to the latest LTS version.
  • Uninstall all non-essential Hexo plugins, or delete node_modules and then reinstall all plugins using npm install --force.

If you decide to submit an Issue, please answer the following questions based on the Issue template:

  • Can you reproduce the problem? Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
  • Did the problem start happening recently or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of NexT? What's the most recent version in which the problem doesn't happen? You can download older versions of NexT from the releases page.
  • Which version of Node, Hexo and NexT are you using? You can get the exact version by running node -v, hexo version in your terminal.
  • Which packages do you have installed? You can get that list by copying the output from npm ls --depth 0 in Hexo root directory.

Keep Up Indentation

When you edit any YAML configs, always need to keep up indents.
Currently, in all Hexo and NexT configuration files parameters uses 2 spaces indents from parent option.

For example, we want to change NexT scheme from standart Muse to Gemini and want to use theme_config feature with Alternate Theme Config.

We open theme config file and under the «Scheme Settings» section copy next parameters:

next/_config.yml
# ---------------------------------------------------------------
# Scheme Settings
# ---------------------------------------------------------------

scheme: Muse
#scheme: Mist
#scheme: Pisces
#scheme: Gemini

Then we open site config file and paste these parameters under theme_config section:

hexo/_config.yml
theme_config:

#scheme: Muse
#scheme: Mist
#scheme: Pisces
scheme: Gemini

Nothing will happen here because indentation not keeped up. Hexo just can't read these parameters because subparameters (children parameters of theme_config parameter) does not exist. Let's see same configuration with indents.

hexo/_config.yml
theme_config:

#scheme: Muse
#scheme: Mist
#scheme: Pisces
scheme: Gemini

And here Hexo can read these parameters as theme_config.scheme: Gemini in same way, as NexT can read scheme: Gemini parameter. So, with 2 spaces indents from parent option(s) Hexo will load all NexT parameters and work fine.

Backtick Code Block in Tags

For Hexo before version 4.0, when backtick code block(s) exists inside other tags (like blockquote, note, tabs), that code block will be generated as «undefined» string in HTML. There are several ways to resolve this:

Instead of Backtick Code Block you can also use tagged Code Block.
But in rare cases standard code block can obtain errors inside other tags.

Use HTML tags instead of Hexo tags: <pre><code>.
In this case you can't add code syntax highlighting.

Here is the PR with bugfix for backtick code block inside tags (Submitted in 2016, merged three years later).
So, upgrade to Hexo 4.0 or later, if you need to use backtick code block inside tags.

Sometimes during generate you can see «Error: Unmatched placeholder remains!» message.
This mean somewhere in your posts, blocks with tags was commented out with {# and #} symbols:

{% raw %}{#
{% label error@Unmatched placeholder remains! %}
#}{% endraw %}
{% raw %}
{% label error@Unmatched placeholder remains! %}
{% endraw %}

TOC Issues

Do not write a skip-level heading in the post. For example, a third-tier heading ### followed by a ##### is not recommended.
See: https://github.com/theme-next/hexo-theme-next/issues/882

If you are using hexo-renderer-markdown-it, it's recommended to install markdown-it-named-headings to make the TOC work correctly.

npm install markdown-it-named-headings

See: https://github.com/theme-next/hexo-theme-next/issues/1168
Here is the PR with bugfix for default config of hexo-renderer-markdown-it plugin.

Favicon Set but Doesn't Work

Put your favicon under site's source dir. If you find that your Favicon doesn't work, please clean your browser's cache first and then visit your Favicon's URL directly, which should be http(s)://your-domain.com/favicon.ico.

If your site is in a subdirectory please set it to favicon: favicon.ico.