Giters

adrienbrignon / mkdocs-exporter

📝 MkDocs Exporter is a powerful plugin for MkDocs that enables seamless conversion of single pages and/or the entire documentation into professional PDF files.

Home Page:https://adrienbrignon.github.io/mkdocs-exporter/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Config value 'plugins': Invalid config options for the 'mkdocs/exporter' plugin.

JayaramaKrishnaGudipati opened this issue · comments

commented

Hi @adrienbrignon,

Hope you remember me, I worked with you for a get_evet_loop issue few weeks back.
I upgraded the plugin version to 3.0.3 and I was using the same mkdocs file given below, I'm receiving the "invalid config" error, please let me know if any other plugin configurations I have to add here in the file,

plugins:
  mkdocs/exporter:
    theme:'material'
  mkdocs/exporter/pdf:
    concurrency: 8
    covers:
      front: resources/templates/covers/front.html.j2
      back: resources/templates/covers/back.html.j2
    stylesheets:
      - resources/stylesheets/pdf.scss
  mkdocs/exporter/extras:
    buttons:
      - title: Download as PDF
        enabled: !!python/name:mkdocs_exporter.plugins.pdf.button.enabled
        icon: !!python/name:mkdocs_exporter.plugins.pdf.button.icon
        attributes:
          href: !!python/name:mkdocs_exporter.plugins.pdf.button.href
          download: !!python/name:mkdocs_exporter.plugins.pdf.button.download

ERROR - Config value 'plugins': Invalid config options for the 'mkdocs/exporter' plugin.
Aborted with 1 Configuration Errors!

Thanks

commented

Hello @JayaramaKrishnaGudipati,

Yes, for sure; thanks again for your contributions to #3.

I guess that the issue here is because your plugins option is an object instead of an array (here's the documentation for reference).
This is what your configuration should look like:

plugins:
  - mkdocs/exporter:
      theme: 'material'
  - mkdocs/exporter/pdf:
      concurrency: 8
      covers:
        front: resources/templates/covers/front.html.j2
        back: resources/templates/covers/back.html.j2
      stylesheets:
        - resources/stylesheets/pdf.scss
  - mkdocs/exporter/extras:
      buttons:
        - title: Download as PDF
          enabled: !!python/name:mkdocs_exporter.plugins.pdf.button.enabled
          icon: !!python/name:mkdocs_exporter.plugins.pdf.button.icon
          attributes:
            href: !!python/name:mkdocs_exporter.plugins.pdf.button.href
            download: !!python/name:mkdocs_exporter.plugins.pdf.button.download
commented

Hi @adrienbrignon ,

Thanks again for responding and supporting on the issue.
I still see the same below error even after changing the plugin to array format as given by you, previously it was working for me when used in object format also, now I see this below error. Could you please let me know the possible causes?

ERROR - Config value 'plugins': Invalid config options for the 'mkdocs/exporter' plugin.
Aborted with 1 Configuration Errors!

Thanks

commented

Hi @JayaramaKrishnaGudipati,

I think the problem lies in your config file, not the plugin itself.
Reading your config file, it looks like you forgot to add a space between the theme property and its value.

plugins:
  - mkdocs/exporter:
      theme:'material'

should be written as:

plugins:
  - mkdocs/exporter:
      theme: 'material'

Could you confirm that adding the missing space resolves your issue, please?

Thanks,

Adrien

commented

Hi @adrienbrignon ,

Yes the space has resolved the plugin config issue. I proceeded further and I have faced the below issue,

ERROR - Config value 'site_dir': The 'site_dir' should not be within the 'docs_dir' as this leads to the build directory being copied into itself and duplicate nested files in the 'site_dir'. (site_dir: '/builds/reusable-ci/include/use-mkdocs/public', docs_dir: '/builds/reusable-ci/include/use-mkdocs')

I followed the solution proposed in the below forum and mentioned docs_dir value to docs.
mkdocs/mkdocs#2145
Just please take this as input and check if this might contribute to your plugin in some way.

I got stucked again with Playwright issue which is not installing with Debian image :)
I'm trying with ubuntu image but facing few issues in installing with project dependencies, currently trying to resolve the dependency issue and proceed with ubuntu image.

You may now close this issue, Thanks again for your response and Support.

Thanks

commented

Hello @JayaramaKrishnaGudipati,

Thank you for your feedback, glad to hear that your issue is now resolved.