search

jimporter / mike

Manage multiple versions of your MkDocs-powered documentation via Git
BSD 3-Clause "New" or "Revised" License
511 stars 45 forks source link

Some config values are not supported despite that they are mentioned in Configuration description. #178

Closed MRosiek closed 9 months ago

MRosiek commented 9 months ago

Summary

When configuring deploy_prefix in mkdocs.yml file, mike is throwing following info: Config value 'plugins': Plugin 'mike' option 'deploy_prefix': Unrecognised configuration name: deploy_prefix

Configuration and Logs

My mkdocs.yml file:

plugins:
  - search
  - include_dir_to_nav:
  - autorefs
  - mike:
      deploy_prefix: 'documentation/site/mike_docs'
      canonical_version: null
      version_selector: true
      css_dir: css
      javascript_dir: js

Steps to Reproduce

  1. configure deploy_prefix in mkdocs.yml file
  2. call mike list or any other command like mike delete --all

Expected Behavior

Config should be set as mentioned in description.

jimporter commented 9 months ago

If you're using v1.1.2, you need to read the README for that version, not the README for the latest development build: https://github.com/jimporter/mike/blob/v1.1.2/README.md

MRosiek commented 9 months ago

Oh, I missed that the main page of this repo describes dev version(in readme.md 1.1.2 version mark was visible at the beginning of the file - It was a little bit misleading for me)

Anyway, thank you for clarification :). I already used mike and it's great 👍