docs/content/pages/setting-up-a-github-pages-s.../troubleshooting-jekyll-buil...

184 строки
11 KiB
Markdown
Исходник Обычный вид История

---
title: Troubleshooting Jekyll build errors for GitHub Pages sites
intro: 'You can use Jekyll build error messages to troubleshoot problems with your {% data variables.product.prodname_pages %} site.'
redirect_from:
- /articles/page-build-failed-missing-docs-folder
- /articles/page-build-failed-invalid-submodule
- /articles/page-build-failed-missing-submodule
- /articles/page-build-failed-markdown-errors
- /articles/page-build-failed-config-file-error
- /articles/page-build-failed-unknown-tag-error
- /articles/page-build-failed-tag-not-properly-terminated
- /articles/page-build-failed-tag-not-properly-closed
- /articles/page-build-failed-file-does-not-exist-in-includes-directory
- /articles/page-build-failed-file-is-a-symlink
- /articles/page-build-failed-symlink-does-not-exist-within-your-sites-repository
- /articles/page-build-failed-file-is-not-properly-utf-8-encoded
- /articles/page-build-failed-invalid-post-date
- /articles/page-build-failed-invalid-sass-or-scss
- /articles/page-build-failed-invalid-highlighter-language
- /articles/page-build-failed-relative-permalinks-configured
- /articles/page-build-failed-syntax-error-in-for-loop
- /articles/page-build-failed-invalid-yaml-in-data-file
- /articles/page-build-failed-date-is-not-a-valid-datetime
- /articles/troubleshooting-github-pages-builds
- /articles/troubleshooting-jekyll-builds
- /articles/troubleshooting-jekyll-build-errors-for-github-pages-sites
- /github/working-with-github-pages/troubleshooting-jekyll-build-errors-for-github-pages-sites
product: '{% data reusables.gated-features.pages %}'
versions:
fpt: '*'
ghes: '*'
ghec: '*'
topics:
- Pages
shortTitle: Troubleshoot Jekyll errors
---
2021-06-14 22:06:52 +03:00
## Troubleshooting build errors
2023-02-15 18:16:18 +03:00
If Jekyll encounters an error building your {% data variables.product.prodname_pages %} site locally or on {% data variables.product.product_name %}, you can use error messages to troubleshoot. For more information about error messages and how to view them, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites)."
If you received a generic error message, check for common issues.
* You're using unsupported plugins. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins)."{% ifversion fpt or ghec %}
* Your repository has exceeded our repository size limits. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github)"{% endif %}
* You changed the `source` setting in your `_config.yml` file. If you publish your site from a branch, {% data variables.product.prodname_pages %} overrides this setting during the build process.
* A filename in your published files contains a colon (`:`) which is not supported.
If you received a specific error message, review the troubleshooting information for the error message below.
After you've fixed any errors, trigger another build by pushing the changes to your site's source branch (if you are publishing from a branch) or by triggering your custom {% data variables.product.prodname_actions %} workflow (if you are publishing with {% data variables.product.prodname_actions %}).
2021-06-14 22:06:52 +03:00
## Config file error
This error means that your site failed to build because the `_config.yml` file contains syntax errors.
To troubleshoot, make sure that your `_config.yml` file follows these rules:
{% data reusables.pages.yaml-rules %}
{% data reusables.pages.yaml-linter %}
{% data reusables.pages.symlink-removal %}
2021-06-14 22:06:52 +03:00
## Date is not a valid datetime
This error means that one of the pages on your site includes an invalid datetime.
To troubleshoot, search the file in the error message and the file's layouts for calls to any date-related Liquid filters. Make sure that any variables passed into date-related Liquid filters have values in all cases and never pass `nil` or `""`. For more information, see [Filters](https://shopify.dev/docs/api/liquid/filters) in the Liquid documentation.
2021-06-14 22:06:52 +03:00
## File does not exist in includes directory
This error means that your code references a file that doesn't exist in your `_includes` directory.
{% data reusables.pages.search-for-includes %} If any of the files you've referenced aren't in the `_includes` directory, copy or move the files into the `_includes` directory.
2021-06-14 22:06:52 +03:00
## File is not properly UTF-8 encoded
This error means that you used non-Latin characters, like `日本語`, without telling the computer to expect these symbols.
To troubleshoot, force UTF-8 encoding by adding the following line to your `_config.yml` file:
```yaml
encoding: UTF-8
```
2021-06-14 22:06:52 +03:00
## Invalid highlighter language
This error means that you specified any syntax highlighter other than [Rouge](https://github.com/jneen/rouge) or [Pygments](https://pygments.org/) in your configuration file.
To troubleshoot, update your `_config.yml` file to specify [Rouge](https://github.com/jneen/rouge) or [Pygments](https://pygments.org/). For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#syntax-highlighting)."
2021-06-14 22:06:52 +03:00
## Invalid post date
This error means that a post on your site contains an invalid date in the filename or YAML front matter.
To troubleshoot, make sure all dates are formatted as YYYY-MM-DD HH:MM:SS for UTC and are actual calendar dates. To specify a time zone with an offset from UTC, use the format YYYY-MM-DD HH:MM:SS +/-TTTT, like `2014-04-18 11:30:00 +0800`.
If you specify a date format in your `_config.yml` file, make sure the format is correct.
2021-06-14 22:06:52 +03:00
## Invalid Sass or SCSS
This error means your repository contains a Sass or SCSS file with invalid content.
To troubleshoot, review the line number included in the error message for invalid Sass or SCSS. To help prevent future errors, install a Sass or SCSS linter for your favorite text editor.
2021-06-14 22:06:52 +03:00
## Invalid submodule
This error means that your repository includes a submodule that hasn't been properly initialized.
{% data reusables.pages.remove-submodule %}
If do you want to use the submodule, make sure you use `https://` when referencing the submodule (not `http://`) and that the submodule is in a public repository.
2021-06-14 22:06:52 +03:00
## Invalid YAML in data file
This error means that one of more files in the __data_ folder contains invalid YAML.
To troubleshoot, make sure the YAML files in your __data_ folder follow these rules:
{% data reusables.pages.yaml-rules %}
{% data reusables.pages.yaml-linter %}
For more information about Jekyll data files, see [Data Files](https://jekyllrb.com/docs/datafiles/) in the Jekyll documentation.
2021-06-14 22:06:52 +03:00
## Markdown errors
This error means that your repository contains Markdown errors.
2023-02-15 18:16:18 +03:00
To troubleshoot, make sure you are using a supported Markdown processor. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll)."
Then, make sure the file in the error message uses valid Markdown syntax. For more information, see [Markdown: Syntax](https://daringfireball.net/projects/markdown/syntax) on Daring Fireball.
2021-06-14 22:06:52 +03:00
## Missing docs folder
This error means that you have chosen the `docs` folder on a branch as your publishing source, but there is no `docs` folder in the root of your repository on that branch.
To troubleshoot, if your `docs` folder was accidentally moved, try moving the `docs` folder back to the root of your repository on the branch you chose for your publishing source. If the `docs` folder was accidentally deleted, you can either:
* Use Git to revert or undo the deletion. For more information, see [git-revert](https://git-scm.com/docs/git-revert.html) in the Git documentation.
* Create a new `docs` folder in the root of your repository on the branch you chose for your publishing source and add your site's source files to the folder. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)."
* Change your publishing source. For more information, see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)."
2021-06-14 22:06:52 +03:00
## Missing submodule
This error means that your repository includes a submodule that doesn't exist or hasn't been properly initialized.
{% data reusables.pages.remove-submodule %}
If you do want to use a submodule, initialize the submodule. For more information, see [Git Tools - Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) in the _Pro Git_ book.
2021-06-14 22:06:52 +03:00
## Relative permalinks configured
This errors means that you have relative permalinks, which are not supported by {% data variables.product.prodname_pages %}, in your `_config.yml` file.
Permalinks are permanent URLs that reference a particular page on your site. Absolute permalinks begin with the root of the site, while relative permalinks begin with the folder containing the referenced page. {% data variables.product.prodname_pages %} and Jekyll no longer support relative permalinks. For more information about permalinks, see [Permalinks](https://jekyllrb.com/docs/permalinks/) in the Jekyll documentation.
To troubleshoot, remove the `relative_permalinks` line from your `_config.yml` file and reformat any relative permalinks in your site with absolute permalinks. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/editing-files)."
2021-06-14 22:06:52 +03:00
## Syntax error in 'for' loop
This error means that your code includes invalid syntax in a Liquid `for` loop declaration.
To troubleshoot, make sure all `for` loops in the file in the error message have proper syntax. For more information about proper syntax for `for` loops, see [Tags](https://shopify.dev/docs/api/liquid/tags/for) in the Liquid documentation.
2021-06-14 22:06:52 +03:00
## Tag not properly closed
This error message means that your code includes a logic tag that is not properly closed. For example, {% raw %}`{% capture example_variable %}` must be closed by `{% endcapture %}`{% endraw %}.
To troubleshoot, make sure all logic tags in the file in the error message are properly closed. For more information, see [Tags](https://shopify.dev/docs/api/liquid/tags) in the Liquid documentation.
2021-06-14 22:06:52 +03:00
## Tag not properly terminated
This error means that your code includes an output tag that is not properly terminated. For example, {% raw %}`{{ page.title }` instead of `{{ page.title }}`{% endraw %}.
To troubleshoot, make sure all output tags in the file in the error message are terminated with `}}`. For more information, see [Objects](https://shopify.dev/docs/api/liquid/objects) in the Liquid documentation.
2021-06-14 22:06:52 +03:00
## Unknown tag error
This error means that your code contains an unrecognized Liquid tag.
To troubleshoot, make sure all Liquid tags in the file in the error message match Jekyll's default variables and there are no typos in the tag names. For a list of default variables, see [Variables](https://jekyllrb.com/docs/variables/) in the Jekyll documentation.
2023-02-15 18:16:18 +03:00
Unsupported plugins are a common source of unrecognized tags. If you use an unsupported plugin in your site by generating your site locally and pushing your static files to {% data variables.product.product_name %}, make sure the plugin is not introducing tags that are not in Jekyll's default variables. For a list of supported plugins, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins)."