Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Interaction with other plug-ins? #19

Open
jmpicnic opened this issue Mar 13, 2023 · 2 comments
Open

Interaction with other plug-ins? #19

jmpicnic opened this issue Mar 13, 2023 · 2 comments

Comments

@jmpicnic
Copy link

jmpicnic commented Mar 13, 2023

First, thanks a lot for publishing this plugin, it does work with confluence quickly and with no trouble at all.

My challenge is how to get it to interact with other mkdocs plugins for some more advanced rendering. When generating the confluence pages, it seems that the underlying renderer (md2cf/mistune) does not take them into account.

I am using this in the mkdocs.yml file:

[...]
# See https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
theme:
  name: material
  features:
    - content.code.annotate

markdown_extensions:
  - tables
  - def_list
  - admonition
  - toc
  - markdown_inline_graphviz
  - plantuml_markdown
  - mdx_truly_sane_lists
# See https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.smartsymbols
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.snippets:
      check_paths: true

plugins:
  - monorepo
  - search
  # https://github.com/pawelsikora/mkdocs-with-confluence
  - mkdocs-with-confluence:
      host_url: https://flexport.atlassian.net/wiki/rest/api/content
      space: !ENV CONFLUENCE_SPACE
      parent_page_name: !ENV CONFLUENCE_PARENT_PAGE
      username: !ENV CONFLUENCE_USER
      password: !ENV CONFLUENCE_TOKEN
      enabled_if_env: MKDOCS_TO_CONFLUENCE
      verbose: false
      debug: false
      dryrun: false

And the rendered pages don't render correctly at least:

  • plantuml
  • snippets
  • admonitions
  • math (MathJax)

Which are all rendered O.K. when generating an html site.

Any ideas would be very appreciated.

@ghost
Copy link

ghost commented May 11, 2023

any solution for pages don't render correctly?

@kha7iq
Copy link

kha7iq commented Jun 20, 2023

I have similar issue
I am using mkdocstrings plugin to generate docs, which are rendered properly for html but plugin publishes the page without it so my confluence page look like this

# Example Module

::: exampleModulePy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants