question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Error: The "offline" plugin is not installed, mkdocs-material docs says should work out-of-the-box

See original GitHub issue

Contribution guidelines

I’ve found a bug and checked that …

  • … the problem doesn’t occur with the mkdocs or readthedocs themes
  • … the problem persists when all overrides are removed, i.e. custom_dir, extra_javascript and extra_css
  • … the documentation does not mention anything about my problem
  • … there are no open or closed issues that are related to my problem

Description

The documentation for material says that you can enable offline plugin, however the build fails saying Error: The "offline" plugin is not installed

$ mkdocs serve
INFO     -  Building documentation...
ERROR    -  Config value: 'plugins'. Error: The "offline" plugin is not installed
Aborted with 1 Configuration Errors!
#mkdocs.yml
plugins:
  - offline:

Expected behaviour

as the documentation states this:

plugins:
  - offline

should work out-of-the-box, I expect it to work out-of-the-box and not error and say “offline plugin not installed”

Actual behaviour

error: offline plugin not installed

Steps to reproduce

plugins:

  • offline

in mkdocs.yml

Package versions

  • Python: python --version
  • MkDocs: mkdocs --version
  • Material: pip show mkdocs-material | grep -E ^Version
$ python --version && mkdocs --version && pip show mkdocs-material | grep -E ^Version
Python: 3.10.4
mkdocs: version 1.3.0
material: Version: 8.2.8

Configuration

site_name: name
site_url: ""
plugins:
  - offline

System information

  • Operating system: …
  • Browser: …

Window, Chrome

Issue Analytics

  • State:closed
  • Created a year ago
  • Comments:8 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
squidfunkcommented, Apr 1, 2022

A legend is definitely a good idea. Furthermore, I understand that the Insiders heart isn’t apparent enough in dark mode. I’m currently in the process of redesigning some parts of the documentation and will incorporate your feedback. Thanks!

1reaction
tljstewartcommented, Apr 1, 2022

I totally understand what you’re saying and I agree. After thinking about this a bit more deeply, the first page I went to was Getting Started then Setup without a reference to what the tags underneath the headers mean (btw, is an elegant way to annotate). I suggest some type of grid layout at the bottom of the Getting Started page with a short description/intent of the tags/symbols. I think its a beautiful site, and I appreciate your work.

image image image

Read more comments on GitHub >

github_iconTop Results From Across the Web

Building for offline usage - Material for MkDocs - GitHub Pages
The built-in offline plugin makes sure that the site search works when you distribute the contents of your site directory as a download....
Read more >
squidfunk/mkdocs-material - Gitter
So the build is running and Webpack is building the assets. Frankly, I don't know where the error could be. If you change...
Read more >
MkDocs Plugins
MkDocs Plugins . A Guide to installing, using and creating MkDocs Plugins. Installing Plugins . Before a plugin can be used, it must...
Read more >
mkdocs-macros-plugin - PyPI
Unleash the power of MkDocs with macros and variables. ... "Manual installation"; Development/test installation; Declaration of plugin; Check that it works.
Read more >
Material for MkDocs - GitHub
ConfigurationError: Aborted with 1 Configuration Errors! Error: Permission denied pip install mkdocs-material. # => Could not install packages due to an ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found