search

unverbuggt / mkdocs-encryptcontent-plugin

A MkDocs plugin that encrypt/decrypt markdown content with AES
https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/
MIT License
123 stars 15 forks source link

Error when using plugin with Material for MkDocs #29

Closed zeldridge closed 2 years ago

zeldridge commented 2 years ago

Hi, I get this error when trying to use the plugin with Material for MkDocs. What am I doing wrong? image

CoinK0in commented 2 years ago

Hi,

The syntax of your YAML seems wrong. Check this part : https://github.com/CoinK0in/mkdocs-encryptcontent-plugin#usage

If you are unable to correct your problem, give me your complete configuration and the version of Mkdocs + the plugin you are using please.

zeldridge commented 2 years ago

Hi thanks for getting back to me.

I copied what you have in usage with the global password and it seems like the syntax is better but still get the error.

image

I am using the latest encryptcontent plugin and latest material for mkdocs version. Anything else I can try?

CoinK0in commented 2 years ago

Complicated to understand without seeing your configuration. For me the problem remains related to the format of your configuration file. Personally I have no reference to "meta" or "invalid value" in my IDE. I can't tell you precisely where your configuration error is located, only thing I can do is provide an example.

Example using the following versions, with python version 3.10.4.

# pip3 list | grep mkdocs
mkdocs                       1.3.1
mkdocs-encryptcontent-plugin 2.2.1
mkdocs-macros-plugin         0.7.0
mkdocs-material              8.4.2
mkdocs-material-extensions   1.0.3

Default configuration file (mkdocs.yml) look like this : 

site_name: PoC_encryptcontent_plugins
theme:
  name: material
plugins:
  - search
  - macros
  - encryptcontent
nav:
  - Home: index.md

And my markdown file for the home page (index.md) looks like this : 

password: 321

# POC mkdocs-encryptcontent
## Project information
blablabla

With this default configuration, everything works correctly on the material theme. The home page is well protected by the password "321". Maybe your problem is related to the use of "meta" on material, as your IDE's info link suggests. https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin

zeldridge commented 2 years ago

I started over in a new folder and got it working! Not sure what happened but a quick restart resolved this issue, thanks for the hand :)