From the get-go, during debugging in Gitter
1 | martinbira |
helped to notice that Octicons support got missing on the project front page: https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#icons, observe there is literal
1 | :octicons-octoface: |
there.
Original bug report message:
I am having a trivial problem. I migrate from v4 to v5.
1 2 3 4 5 | yaml extra: social: - icon: octicons/mark-github link: 'https://github.com/Anton-Latukha' |
Docs, not directly, tell that Octicons seems to be supported out of the box, and that they live in the
1 | octicons |
namespace.
I exhausted variants,
1 | octicons |
or
1 | octicon |
or without namespace,
1 | mark-github |
or
1 | github |
.
As only
1 | fontawesome |
example covered in a docs, and indeed
1 | fontawesome/brands/github-alt |
works, but
1 | octicons/mark-github |
does not worked for me.
Wrapper: Error log:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 | text > docker run --rm -it -p 8000:8000 -v (pwd):/docs mkdocs-material build INFO - Cleaning site directory INFO - Building documentation to directory: /docs/Anton-Latukha.github.io Traceback (most recent call last): File "/usr/local/bin/mkdocs", line 8, in sys.exit(cli()) File "/usr/local/lib/python3.8/site-packages/click/core.py", line 829, in __call__ return self.main(*args, **kwargs) File "/usr/local/lib/python3.8/site-packages/click/core.py", line 782, in main rv = self.invoke(ctx) File "/usr/local/lib/python3.8/site-packages/click/core.py", line 1259, in invoke return _process_result(sub_ctx.command.invoke(sub_ctx)) File "/usr/local/lib/python3.8/site-packages/click/core.py", line 1066, in invoke return ctx.invoke(self.callback, **ctx.params) File "/usr/local/lib/python3.8/site-packages/click/core.py", line 610, in invoke return callback(*args, **kwargs) File "/usr/local/lib/python3.8/site-packages/mkdocs/__main__.py", line 152, in build_command build.build(config.load_config(**kwargs), dirty=not clean) File "/usr/local/lib/python3.8/site-packages/mkdocs/commands/build.py", line 285, in build _build_theme_template(template, env, files, config, nav) File "/usr/local/lib/python3.8/site-packages/mkdocs/commands/build.py", line 108, in _build_theme_template output = _build_template(template_name, template, files, config, nav) File "/usr/local/lib/python3.8/site-packages/mkdocs/commands/build.py", line 87, in _build_template output = template.render(context) File "/usr/local/lib/python3.8/site-packages/jinja2/environment.py", line 1090, in render self.environment.handle_exception() File "/usr/local/lib/python3.8/site-packages/jinja2/environment.py", line 832, in handle_exception reraise(*rewrite_traceback_stack(source=source)) File "/usr/local/lib/python3.8/site-packages/jinja2/_compat.py", line 28, in reraise raise value.with_traceback(tb) File "/usr/local/lib/python3.8/site-packages/material/404.html", line 4, in top-level template code {% extends "base.html" %} File "/usr/local/lib/python3.8/site-packages/material/base.html", line 180, in top-level template code {% block footer %} File "/usr/local/lib/python3.8/site-packages/material/base.html", line 181, in block "footer" {% include "partials/footer.html" %} File "/usr/local/lib/python3.8/site-packages/material/partials/footer.html", line 55, in top-level template code {% include "partials/social.html" %} File "/usr/local/lib/python3.8/site-packages/material/partials/social.html", line 13, in top-level template code {% include ".icons/" ~ social.icon ~ ".svg" %} File "/usr/local/lib/python3.8/site-packages/jinja2/loaders.py", line 197, in get_source raise TemplateNotFound(template) jinja2.exceptions.TemplateNotFound: .icons/octicons/mark-github.svg |
1 | octicons/mark-github |
to work and be provided as an example in the doc.
Octicons are currently missing.
To reproduce:
I am using the freshest
1 | master |
1 "Prepare 5.3.3 release" commit 09e5e38a5ccd7cfaf07a58d81a95e3667d1d2d72.
2. On that checkout I use fresh current container build from the current Dockerfile.
3. So I receive
1 | master |
and rebase onto it a minor
1 | Dockerfile |
addition:
1 2 3 4 5 | Dockerfile RUN pip install --no-cache-dir \ pygments \ pymdown-extensions \ mkdocs-htmlproofer-plugin |
, which should not involve in the case of the report.
Gathered from whithin Dockerfile container:
*
1 | Python 3.8.1 |
*
1 | mkdocs, version 1.1.2 from /usr/local/lib/python3.8/site-packages/mkdocs (Python 3.8) |
* Material:
1 | Version: 5.3.3 |
Currently:
Wrapper: `mkdocs.yml`:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 | yaml # Project information site_name: 'Latukha: Good day my friend!' site_description: 'Official page of Anton Latukha' site_author: 'Anton Latukha' site_url: 'https://blog.latukha.com' site_dir: 'Anton-Latukha.github.io' # Structure nav: - 'Home': 'index.md' - 'Biography': 'bio.md' - 'About': 'about.md' - Articles: - 'Fundamental Haskell notes': 'haskell-notes.html' - 'Integrating NixOS/Nix, Haskell IDE Engine, Emacs': 'NixOS-HIE-Emacs.md' - 'Restore of deleted LVM (Advanced)': '2017-05-04-Restore-of-deleted-LVM-(Advanced).md' - 'How to setup proxy to listen Spotify': '2017-04-14-How-to-setup-proxy-to-listen-Spotify.md' - 'SaltStack formulas': '2017-04-12-SaltStack-Formulas-install.md' # Copyright copyright: '2016-2019 Anton Latukha, Creative Commons ShareAlike' # Documentation and theme theme: name: 'material' palette: primary: 'deep purple' accent: 'deep purple' font: text: 'Ubuntu' code: 'Hack' icon: logo: 'assets/images/favicon-min.png' logo: 'assets/images/favicon-min.png' favicon: 'assets/images/favicon-min.png' features: - tabs - instant # Repository repo_name: 'Profile' repo_url: 'https://github.com/Anton-Latukha' edit_uri: '/mkdocs-blog/tree/master/docs' remote_name: 'u' remote_branch: 'master' # repo_name: 'Site content on GitHub' # repo_url: 'https://github.com/Anton-Latukha/Anton-Latukha.github.io' # Options extra: social: - icon: octicons/mark-github link: 'https://github.com/Anton-Latukha' - icon: 'fontawesome/brands/gitlab' link: 'https://gitlab.com/Anton.Latukha' - icon: 'fontawesome/brands/twitter' link: 'https://twitter.com/piroxiline' - icon: 'fontawesome/brands/linkedin' link: 'https://linkedin.com/in/anton-latukha-2a286690' - icon: 'octicons/heart' link: 'https://github.com/Anton-Latukha/Anton-Latukha.github.io/raw/master/assets/docs/AntonLatukhaCV.pdf' - icon: 'octicon/download' link: 'https://github.com/Anton-Latukha/Anton-Latukha.github.io/raw/master/assets/docs/AntonLatukhaCV.pdf' - icon: 'fontawesome/brands/linux' link: 'https://wiki.archlinux.org/index.php/Special:Contributions/Anton_Latukha' - icon: 'fontawesome/brands/linux' link: 'https://wiki.archlinux.org/index.php/Special:Contributions/PiroXiline' disqus: 'blog-latukha-com' # Extensions markdown_extensions: - admonition # summaries, notes, hints or warnings. - codehilite: # Table of Contents extension guess_lang: false linenums: true - toc: permalink: true - pymdownx.arithmatex # Parse LaTeX formulas - pymdownx.betterem # improves the handling of emphasis markup - pymdownx.superfences # ability to nest code blocks under blockquotes, lists and other block elements - pymdownx.inlinehilite # support for inline code highlighting - pymdownx.smartsymbols # converts markup for special characters into their corresponding symbols plugins: - search - minify - htmlproofer |
该提问来源于开源项目:squidfunk/mkdocs-material
Oh, I see, it is a "style" difference.