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

bibtex makes the normal link in mkdocs not working. #289

Closed
leiwu84 opened this issue Jan 19, 2025 · 4 comments · Fixed by #290
Closed

bibtex makes the normal link in mkdocs not working. #289

leiwu84 opened this issue Jan 19, 2025 · 4 comments · Fixed by #290

Comments

@leiwu84
Copy link

leiwu84 commented Jan 19, 2025

I have made a simple example.

The repo directory tree is:

├── docs
│   ├── index.md
│   └── refs.bib
├── mkdocs.yml

The mkdocs.yml file is:

site_name: My site
docs_dir: docs

theme:
  name: material

nav:
  - Home: index.md

plugins:
  - autorefs
  - search
  - bibtex:
      bib_file: 'docs/refs.bib'

The file content of index.md contains a normal link: [displaying text](url).

This is [google](www.google.com).

If I use mkdocs-bibtex==2.14.5, the link. of google is rendered correctly.

Image

But if I use mkdocs-bibtex==3.0.0, the link. of google is rendered incorrectly.

Image

Can you please help with this? Thanks!

@vinman1
Copy link

vinman1 commented Jan 20, 2025

Hello, I confirm experiencing the same issue when upgrading from version 2.21.0 to version 3.0.0.

Also, The version 3.0.0 seems to also break certain code blocks, e.g. this mermaid.js code block no longer works when included with mkdocs-material:

```mermaid
flowchart LR
    one([Text1])
    two([Text2])
    three([Text3])

    one-->two-->three
flowchart LR
    one([Text1])
    two([Text2])
    three([Text3])

    one-->two-->three
Loading

@j-machacek
Copy link

Hello, just to support this bug report.
We are experiencing the same issues.

@shyamd
Copy link
Owner

shyamd commented Jan 21, 2025

I'm able to recreate the link example and will release a fix soon. I'm unable to recreate the mermaid JS example to fail. You run mkdocs build with -v and look at the debug output where it will show you the markdown before and after mkdocs-bibtex processes it. That is the best way to confirm this extension is making the change.

@vinman1
Copy link

vinman1 commented Jan 21, 2025

thanks @shyamd ! I confirm that your fix in version 4.0.1 has fixed both the normal links and my mermaid JS issue. Much appreciated 🥳

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

Successfully merging a pull request may close this issue.

4 participants