grnet / docusaurus-terminology

Home of Docusaurus Terminology Plugin
BSD 2-Clause "Simplified" License
35 stars 5 forks source link

Glossary page only shows "loading.." #5

Closed rethab closed 11 months ago

rethab commented 1 year ago

I have integrated this plugin and the tooltip part works well (shows information and links to term). However, on the glossary page, I only see "loading..". What could be the reason for that?

Since I don't see anything in the logs, how would I start investigating such an issue?

tsironis commented 1 year ago

Thanks for reporting this bug. I will close this one, since it is a duplicate of #2

I will release a next release candidate version in the next few hours.

tsironis commented 1 year ago

This should be fixed in the latest version. Can you upgrade and check that it works as expected?

tsironis commented 1 year ago

@rethab reopening this issue. Can you provide more details on this bug? I cannot fully understand the issue. Maybe add a screenshot, some code that may help us reproduce the bug, platform information etc.

rethab commented 1 year ago

Thanks, @tsironis.

FWIW the tooltips work. It's just the glossary that shows this "Loading... " thingy.

Here's my glossary:

---
id: glossary
title: Glossary
---

This is a glossary

This is how it renders:

image

In case it's relevant, I'm not using the live-reload feature. I first built the documentation using npm run build and then I use npm run serve.

This is a snippet from my docusaurus config:

  plugins: [
    [require.resolve("docusaurus-lunr-search"), { indexBlog: false }],
    ['drawio', {}],
    ['@grnet/docusaurus-terminology', { termsDir: './docs/01-meta/terms', docsDir: './docs/', glossaryFilepath: './docs/01-meta/02-glossary.md' }],
  ],

Versions used:

tsironis commented 1 year ago

@rethab I think that the rc.3 version solves this bug.

tsironis commented 1 year ago

Reopening, I accounted for the folder index, but not for the file index, as seen in your example from your last comment.

tsironis commented 1 year ago

Hmmm, it seems to be working after all, can you check if it works for you as well please? You can then go ahead and close this issue!

rethab commented 1 year ago

Hi, thanks for working on this. I now see a list of terms on the glossary page, however, the link that should point to the term page there doesn't work.

Also I noticed that when using this plugin, the link on the regular page (where the tooltip is shown) is no longer generated correctly.

Without the plugin, the link

[CNP](../01-meta/terms/cnp.mdx)

points to

http://localhost:3000/wiki/meta/terms/CNP

however with the plugin, it points to:

http://localhost:3000/wiki/docs/01-meta/terms/cnp

Note how 01-meta is my folder name, but not the name I want in my URL path :)

tsironis commented 1 year ago

@rethab I just released 1.0.0-rc.4 version. It should be working now.

rethab commented 1 year ago

It now links to http://localhost:3000/wiki/docs/meta/terms/cnp

So two problems:

tsironis commented 1 year ago

Alright, I guess I have a slighlty different example than your installation. Could you provide a repo that reproduces the issue in your latest comment?

tsironis commented 1 year ago

@rethab do you have a different for the plugin-content-docs plugin? Will you be able to provide me the contents of docusaurus.config.js?

tsironis commented 11 months ago

@rethab I'm closing this one since it is stale, go ahead and reopen it if the issue still persists.