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
2
votes
1 answer

How do I get my docusaurus page to start with dark mode as default

How do I get my docusaurus page to start with dark mode as default instead light mode as it comes by default ? thank you.
Candido De Manchuria
  • 21
  • 3
2
votes
1 answer

How to add cards in docusaurus site just like implemented in playground page in docusaurus site?

I want to add cards to my docusaurus v2 site just like in the Playground Page in docusaurus.io/docs/playground. Can someone tell me how to implement it?
Rudra Sen
  • 21
  • 2
2
votes
1 answer

How do I read raw contents of markdown file into string using webpack 5 and docusaurus

I am currently refactoring a Docusaurus app that displays developer documentation from markdown docs. The app has a "quick start" feature which has a wizard that users fill out info and then it populates a markdown template. The app used to use…
Kevin Patrick
  • 444
  • 1
  • 7
  • 17
2
votes
0 answers

Docusaurus v2 set security headers

In Docusaurus v2 I want to implement some security headers. But I couldn't find any documentation about security headers in Docusaurus. Here are some header I want to add, especially to prevent other embed my docusaurus web as iframe. headers: [ …
Irene
  • 21
  • 1
2
votes
0 answers

Can I include / exclude content in mdx file based on a variable set at build time?

I am enjoying using Docusaurus, it is a nice change for me. I am using Docusaurus v2.18. I would like to be able to build two different sets of docs from one set of source files. There will be some differences in some of the content depending on…
DanR
  • 66
  • 5
2
votes
0 answers

How To Debug Failure to Scroll to Fragment ID in Chrome?

I have a page which defines some DOM elements with fragment ids:

...

And I have some anchors on the page that reference these id's: ... This works fine. What doesn't work is visiting http://.../page#foo - i…
CraigJPerry
  • 973
  • 1
  • 8
  • 16
2
votes
4 answers

Deploy an Express server that uses express.static to serve a build folder to Vercel

I've implemented an express server that uses express.static to serve the build folder created from a static docusaurus site in order to apply basic authentication to access the site. This is working great locally, but I'm running into troubles when…
Alyssa De Metro
  • 61
  • 3
2
votes
2 answers

Brief HTTP 404 error on all pages in /docs

I recently deployed our Docusaurus site for the first time and I am running into a weird issue with routing. Every page in the /docs folder will briefly render the 404.html page when hitting the page directly. However, if I click around in sidebar…
Lane Goolsby
  • 594
  • 1
  • 8
  • 26
2
votes
1 answer

How to modify custom.css styling on Docusaurus items

I am looking for the syntax needed to reference an item in Docusaurus allowing me to modify the background color/text color of a collapsed item. Example image enter image description here How exactly can I reference docusaurus code to modify the…
CJ B
  • 21
  • 2
2
votes
0 answers

Integrate C++ documentation into docusaurus

I have a large code base that I do want to document with docusaurus. I used doxygen for the project before but I like docusaurus more now. Is there a way to integrate the C++ functions/classes/methods into docusaurus without having to manually write…
Can
  • 123
  • 2
  • 8
2
votes
0 answers

DocuSaurus - Automatic JavaScript documentation

Is there a plugin or library that can be used to convert JavaScript code and comments into documentation in DocuSaurus? The only option I found was using jsdoc-to-markdown, and I would like to know if there are other options. I'm looking to…
user5507535
  • 1,580
  • 1
  • 18
  • 39
2
votes
0 answers

Docusaurus MDX - create links with a version variable

I'm using Docusaurus for building a documentation web-site for a project. The content is written as MDX files. Since the project has different versions I'd like to use links that contain the specific version. For example, for version 1.0 a link…
seladb
  • 852
  • 1
  • 13
  • 29
2
votes
2 answers

docusaurus links on google app engine give SEO problems

I have set up a website using docusaurus which works great, but when I check the indexing status of my website on google, I got a lot of 'Discovered - currently not indexed' problems, which appears to be a routing problem. The compiled version of…
Jan
  • 300
  • 1
  • 3
  • 8
2
votes
2 answers

Custom Inline Script with Docusaurus

I'm trying to add the wowhead tooltips to a docusaurus page. The wowhead documentation suggests you need to add the following to your section: