Stack Overflow
Stack Overflow

Questions tagged [docusaurus]

Docusaurus is a modern static site generator focused on documentation. It helps you to focus on your content and build optimized websites quickly.

Docusaurus is a performant static site generator by Facebook and can be used to create common content-driven websites (e.g. Documentation, Blogs, Product Landing and Marketing Pages, etc) extremely quickly. Its features:

  • Write using Markdown - Save time and focus on your project's documentation. Simply write docs and blog posts with Markdown and Docusaurus will publish a set of static html files ready to serve.
  • Built using React - Extend or customize your project's layout by reusing React. Docusaurus can be extended while reusing the same header and footer.
  • Translations - Localization comes pre-configured. Use Crowdin to translate your docs into over 70 languages.
  • Versioning - Support users on all versions of your project. Document versioning helps you keep documentation in sync with project releases.
  • Search - Make it easy for your community to find what they need in your documentation. We proudly support Algolia documentation search.

Useful Links

477 questions
7
votes
1 answer

How can we link a Docusaurus website to a database?

I'm building a website with Docusaurus V2. Since a Docusaurus website is fundamentally a React app, I wonder how we could add an authentication system to the website. Is there any guide or sample where a Docusaurus website is linked to a database,…
SoftTimur
  • 5,630
  • 38
  • 140
  • 292
6
votes
1 answer

Github codespaces project live preview not working

I am running a simple project of Docusaurus with npm start which runs successfully. Using Github Codespaces to run the project but the forwarded route doesn't seem to be working. Attached the screenshots of environment.
kazmi066
  • 573
  • 5
  • 15
6
votes
0 answers

Docusaurus: is writing to the filesystem during loadContent poor practice for plugins?

I'd like to populate my Docusaurus project with documentation using the "docs" plugin and a custom (JavaScript) plugin to connect it to a headless CMS. Currently, I'm using the loadContent Lifecycle API event to call my Headless CMS API and then…
Michael Berry
  • 81
  • 2
6
votes
3 answers

Redirect to docs from landing page in docusaurus v2

Since I don't have a landing page, I would like to redirect to the main doc page docs/main I tried to follow the instructions: https://docusaurus.io/docs/en/site-creation#docs-landing-page from v1, but they don't seem to work for v2. Can someone…
Maru
  • 71
  • 1
  • 3
6
votes
2 answers

Center a hyperlink or an image in Docusaurus

I'm building a website with Docusaurus V2. I have a file link: [10Studio-Sample-EN.xlsx](https://www.10studio.tech/files/10Studio-Sample-EN.xlsx) Now, I want to put that link in the center (traditionally with text-align: center). I tried the…
SoftTimur
  • 5,630
  • 38
  • 140
  • 292
6
votes
1 answer

Docusaurus - how to open external links in new tab?

I am using Docusaurus and would like to open external links in new tabs. I would prefer to use code for this rather than the solution of writing html code in my markdown document as per this answer. I have tried this…
RedBeard
  • 145
  • 2
  • 15
5
votes
0 answers

Docusaurus: how to display the link "Edit this page" on every doc page?

This will be a fairly easy question I assume but for the life of me, I can't figure out the answer. What I want: I want to display my Docusaurus documentation pages with a "Edit this page" link on every page. What I tried: My understanding is…
tik
  • 51
  • 3
5
votes
2 answers

On Docusaurus, how do I disable the external link SVG?

I'm trying to implement Sign in and Sign up buttons on the Docusaurus navbar... ...but since my app is in a subdomain, Docusaurus thinks they are external links and adds this ugly SVG. How do I disable the external behavior? I was looking for an…
Andre Pena
  • 56,650
  • 48
  • 196
  • 243
5
votes
2 answers

Docusaurus 2 How to add custom react component in navbar

From the docusaurus docs, the navbar items can only have certain types like link, dropdown and search. How do I add custom buttons like if I want to add login button ?
Kevin Kihata
  • 131
  • 4
5
votes
1 answer

Unable to start Docusaurus 2 website because of unknown markdown errors

When starting yarn for my docusaurus 2 website, I see that the website is running on a local host (http://localhost:3000/). However, I noticed that there was an Unterminated JSX contents error. Despite the markdown being correct. This is the error…
KenD
  • 51
  • 2
5
votes
4 answers

Docusaurus v2 and GraphQL Playground integration

I'd like to render GraphQL Playground as a React component in one of my pages but it fails due to missing file-loader in webpack. Is there a way to fix this in docs or do I need to create new plugin with new webpack config? Is it good idea to…
Josef Rybička
  • 87
  • 1
  • 8
5
votes
3 answers

Does Docusaurus support renaming the 'docs' output folder?

I am currently evaluating using Docusaurus to generate a static web site. The site itself is not documentation focused, in fact, the site is not even computer or technology related. But as a techie myself, I want a CI and Git-powered publishing…
cleardemon
  • 365
  • 5
  • 13
4
votes
0 answers

Hook useTabGroupChoice is called outside the error while using docusaurus-plugin-openapi-docs

I'm testing docusaurus-plugin-openapi-docs on my docusaurus website and trying to run the example (petstore). The files are generated properly and are showing on my sidebar. However, when I click on the items I get this error Hook useTabGroupChoice…
kerv
  • 41
  • 2
4
votes
1 answer

How to tweak Docusaurus webpack config for some react component?

It seems that one of my component ( https://www.npmjs.com/package/@stoplight/json-schema-viewer ) needs some tweaks in webpack with Docusaurus Any ideas ? I tried to follow https://gist.github.com/sibelius/24f63eef7f43b15dc73c4a0be11bbef8 but it…
jy95
  • 773
  • 13
  • 36
4
votes
0 answers

Include specific lines of code from a source file in Docusaurus

I'm currently deciding whether to migrate my developer docs from Sphinx to Docusaurus. The one thing that's holding me back is that Docusaurus (and in fact Markdown in general) doesn't support pulling specific lines of text from other files. Sphinx…
kenna
  • 51
  • 1
1
2
3
…
31 32