Build my GitHub Page got error: Invalid syntax for include tag.

[Latisha19]

Context

I got an error after I set the submodule to your git.
This error occurred after I successfully served mkdocs, others had nothing to do.

Not sure if this is a bug or not for I have not found anyone who had this error, but after checking all issue types, I thought I could report it as a bug.
What can I do for this?

Bug description

When my GitHub page do "pages build and deployment", it gets error at "Build with Jekyll" and says that:

Liquid Exception: Invalid syntax for include tag. File contains invalid characters or sequences: ".icons/fontawesome/brands/youtube.svg" Valid syntax: {% include file.ext param='value' param2='value' %} in mkdocs-material/docs/reference/icons-emojis.md
/usr/local/bundle/gems/jekyll-3.10.0/lib/jekyll/tags/include.rb:67:in `validate_file_name': Invalid syntax for include tag. File contains invalid characters or sequences: (ArgumentError)

  ".icons/fontawesome/brands/youtube.svg"

The following image is part of the problem display:

Related links

• Reporting a bug

Reproduction

9.5.49-bug_fail.zip

Steps to reproduce

1. run locally cmd with: Installation - Material for MkDocs
2. run locally cmd with: Creating your site - Material for MkDocs (different: not add site_url)
3. run action for "Create ci.yml" with the following URL: Publishing your site - Material for MkDocs
4. Got error: Error: Config file 'mkdocs.yml' does not exist. Error: Process completed with exit code 1., but mkdocs.yml surely exists under my root Github page.
5. "pages build and deployment" also failed. Error as above I provided.
6. Re-run "Create ci.yml" and "pages build and deployment" but still got same error.

Browser

Chrome

Before submitting

• I have read and followed the bug reporting guidelines.
• I have attached links to the documentation, and possibly related issues and discussions.
• I assure that I have removed all customizations before submitting this bug report.
• I have attached a .zip file with a minimal reproduction using the built-in info plugin.

[squidfunk]

Thanks for reporting. This is not a problem with Material for MkDocs, but with your configuration. I'm converting this into a discussion, so somebody from the community can help you figure it out.

[Latisha19]

@squidfunk Thanks for your kind help! Next time if I have a similar problem, I will put it into discussion. Sorry for my silly.

[niclasheinz]

Hi @Latisha19

I have looked at your ZIP file, but I couldn't find a .github folder in the root directory. Could you please let us know where your GitHub Action file is located? Is it correct that you have integrated a copy of the mkdocs-material repository into your own?

Could you give us more information about your setup?

[kamilkrzyskow]

The README.md files shows it's this repository https://github.com/Latisha19/Latisha19.github.io

The submodule is added, however the ci.yaml still uses pip install mkdocs-material, which downloads the package from pip. I personally never used the submodules functionality, so I might be missing something, but the current setup doesn't make sense.
To install from the local directory it would be pip install -e ./mkdocs-material

As for the actions, the ci.yaml works, only the deploy crashes with jekyll.
The incorrect branch is being used for the deployment, it should be gh-pages, so duplicate issue of this, which can be found searching for jekyll:

• Documentation looks beautiful locally but unstyled when deployed on GH pages #7773

[Latisha19]

@niclasheinz Since I haven't solved my problem yet, I won't attach the .github folder. In addition, if GitHub Action refers to ci.yml, I put it in .github\workflows\ci.yml in the root directory.

@kamilkrzyskow Oh my god! I had seen that discussion, but I didn't notice that it should be useful for me! Thanks for your reply; I finally deployed successfully.

[kamilkrzyskow]

@Latisha19 You've changed gh-pages to be the default branch. This doesn't seem right, as this branch is not modified directly by you and is overridden every time mkdocs gh-deploy is being run in CI. I recommend sticking to the main default branch and only change the branch in the GitHub Pages settings.

[Latisha19]

@kamilkrzyskow Thanks for your advice! I mistake for that. Had changed it to the correct way.

[kamilkrzyskow]

Now you've merged the files from 2 branches 😢