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.
@danielspofford it would greatly help me if you provided a minimal repro that reports broken anchors that you would like to solve. This way, I could see how to fix that repro so that those anchors do not get reported anymore.
Your repro just shows an attempt to import a React hook in Node.js code, something that is illegal). I can't act on it, and fix the problem, because the problem is not showcased in the first place. Show me the problem and I'll help fix it. Seeing a runnable sandbox of your setup that actually reports wrong broken anchors is more helpful than explaining things in text form.
from docusaurus.
@slorber here is a minimal repro that reports broken anchors that I would like to solve.
https://codesandbox.io/p/devbox/distracted-cache-7xxfh5
from docusaurus.
Related Issues (20)
- Broken anchors: page not scroll to the right section HOT 8
- Index pages cannot be generated with an automatically generated siderbar HOT 1
- Document solution to "docs last update" date being rendered incorrectly when published through Vercel
- Customizing admonitions not work HOT 3
- When testing on StrictMode, the bar remains on the top HOT 1
- Node.js building getting stuck HOT 2
- Updating to @mdx-js/react 3.0.1 causes admonition blocks to stop rendering colored box HOT 8
- The <!--truncate--> line in my long blog post on the initialized website is not causing the blog post size to be limited. HOT 1
- Add trailing slash to auto generated sitemap.xml for directories only HOT 3
- blogTitle not working HOT 4
- Algolia Contextual Search Generates Incorrect FaceFilters HOT 6
- Multi-Instance Routes Not Working in v3.2.1 HOT 3
- Home page renders twice, one below the other. HOT 1
- Details elements aren't searchable - a11y issue HOT 8
- WARNβ 1 deprecated subdependencies found: [email protected] HOT 1
- npm run build fails when nmetadata are missing HOT 3
- Broken link transformation HOT 2
- Ability to Skip Homepage and Directly Access Feature Page HOT 1
- Light/Dark Mode issues on older versions of Safari 12,13, and 14 HOT 3
- Problems with locale url on homepage and blog HOT 1
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.