Comments (6)
Hi! You cannot use useBrokenLinks
in a plugin file. Plugins are run in Node. You can only use it in a theme component. I think we should explain better how to register anchors directly in the plugin.
from docusaurus.
Appreciate your confirmation @Josh-Cena - I figured as much after continuing my efforts.
I think we should explain better how to register anchors directly in the plugin.
If this is possible can you please point me at anything (docs/source examples/whatever) that would shine some light on how I do that? Exactly what I'm after.
from docusaurus.
I somewhat suspect that it's impossible, since right now only the rendering code reports back valid anchors. I'll let @slorber answer though; if it's really not achievable, maybe we should have an API. It sounds useful for plugins that create external HTML pages that don't use Docusaurus themes.
from docusaurus.
I suspect that as well.
It sounds useful for plugins that create external HTML pages that don't use Docusaurus themes.
Yeah that is my exact use case. Was trying to work around rohit-gohri/redocusaurus#321.
The problem for me is that:
- In a plugin:
- I have access to the external HTML page's content (fs.reads in postBuild), and I can get anchors I would like to collect from it, but I cannot tell docusaurus about those anchors as discussed in this issue.
- In a theme component:
- I can tell docusaurus about anchors (via
useBrokenLinks
), but I do not have access to the external HTML page's content, so I cannot get anchors I would like to collect from it.
- I can tell docusaurus about anchors (via
Just to see if it was possible, I tried to: generate the anchors in the plugin, stick them in global data, and then access them from a theme component so that I could useBrokenLinks
. But there is an order of operations problem:
- In order for my plugin to generate the anchors, the external HTML must already exist.
- External HTML will only exist from my plugin's POV at time of postBuild.
- setGlobalData is only available at time of contentLoaded, not in postBuild, so I cannot pass the anchors through because by the time I get them, I cannot setGlobalData.
Regardless of the order of operations problem, it feels wrong to me to serialize and pump that data around in that manner. Seems like allowing for that in plugins like you say would be very nice for this use case.
from docusaurus.
Related Issues (20)
- [Accessibility]: Page looses focus after Search modal gets closed HOT 1
- Please Block the "Bruce's Wiki" at show case since contain the Malicious links HOT 2
- Place screenshots in the themes documentation page in the site HOT 2
- Passing custom props to IdealImage HOT 2
- Spaces are no longer valid in links HOT 4
- Cannot load docs from outside local package root when running as a Yarn workspace HOT 8
- Mermaid diagram shift page when opening a link with anchor HOT 1
- An error occurred when importing a global component. The component cannot be found HOT 1
- Error messages set to `vfile` by Remark plugins are not reported. HOT 1
- Use pure examples in github action deployment examples HOT 1
- When multiple i18n are configured, the plug-in will report an error when using the Link tag. HOT 1
- Can't find component when using NX and NPM Workspaces HOT 2
- Add comparison to vitepress HOT 2
- Module not found: Error: Can't resolve 'react-loadable' in '.../node_modules/@docusaurus/core/lib/client/exports' HOT 1
- BrowserOnly, lazy, and useHistory result in infinite re-rendering HOT 1
- Output HTML contains NULL chracters in at least CJK languages HOT 10
- The mdx-code-block is not compatible with Windows. HOT 3
- Using partial props in links causes false positive `onBrokenLinks` HOT 2
- SPA opt-out: make prefetching/preloading and routing configurable HOT 8
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docusaurus.