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

Docsearch on subpath '/docs' not scraping side navigation

A Docusaurus documentation website: https://slovakia-atmo-plan.marvintest.vito.be/docs/ is rendered in Docs only mode. The Algolia Docsearch scraper is not scraping root level pages, instead it logs Ignored: from start url. This issue only seems to…
Hoetmaaiers
  • 3,413
  • 2
  • 19
  • 29
0
votes
0 answers

How to create an index page with links to multiple dynamic files with Docusaurus?

Assuming the following file structure, if I want to link from directory_1/file_1.md to an index page containing links to all files in directory_2: Would I need to create the index page in directory_2 or can I just link to the directory some way? If…
Pierre Delecto
  • 455
  • 1
  • 7
  • 26
0
votes
1 answer

How do I override Docusaurus styling?

I'm implementing Docusaurus into a pre-existing webapp for user documentation. It works perfectly for what I'm trying to accomplish, but I want to change some of the baked-in styling across the app, which, I believe, comes from the package itself,…
Julian George
  • 101
  • 1
  • 2
  • 9
0
votes
1 answer

How can I start Docusaurus as a service on Linux (Ubuntu)

Hi guys I try to start Docusaurus V2 as a service on ubuntu headless. Currently I have a script in my Docusaurus folder as a temporarly solution. It works when I start it with ./start.sh: /var/www/citro-docs-2/start.sh #!/bin/bash npm run serve I…
Micha
  • 3
  • 1
0
votes
0 answers

Docusaurus V2 issue rendering

Using Docusaurus 2.0.0-beta.4 import React, { useEffect, useState } from 'react'; import clsx from 'clsx'; import Layout from '@theme/Layout'; import Link from '@docusaurus/Link'; import useDocusaurusContext from…
Albin Joseph
  • 1
0
votes
1 answer

How can I reference a document outside of the Docusaurus docs directory?

I would like to organize all of my Docusaurus docs under a docs directory. However, I would also like to reference existing markdown documents such as README.md etc. How can I reference documents that are outside the docs directory from sidebar.js?
linuxdan
  • 4,476
  • 4
  • 30
  • 41
0
votes
1 answer

Deploying Docusaurus V2 on GitHub Pages with GIT_USER= yarn deploy prints "-bash: No such file"

I can't find any applicable information on this and would appreciate some help: I am trying to deploy a Docusaurus V2 site to GitHub pages using the WSL command line. I'm using the GIT_USER= yarn deploy command. This doesn't work…
Nataly
  • 19
  • 5
0
votes
1 answer

Docusaurus v2- Search Bar does not appear while using Build

I have created a new site using Docusaurus v2. I had installed the core as well as the theme-search-algolia packages as provided here. When I run the site locally using npm run start, the Search bar is visible on the top as shown below. Locally…
Altaf Akhai
  • 1
  • 1
0
votes
1 answer

root component swizzle in docusaurus v2 not working

I am trying to wrap my website with a root component: https://docusaurus.io/docs/using-themes#wrapper-your-site-with-root. I made src/theme/Root.js with following code in it: import React from 'react'; // Default implementation, that you can…
Ravi Soni
  • 141
  • 1
  • 12
0
votes
1 answer

Page with dynamic content shifting to the middle on loading only safari

I created a docusaurus based website which includes some custom react components that are loaded with dynamic import using loadable-components. When I navigate between the pages both Chrome and Firefox work as expected but on Safari, as the page is…
Siva
  • 1,096
  • 7
  • 20
0
votes
1 answer

Docusaurus versionning

If I do not want to show this next in the dropdown nav menu. What should I do? enter image description here Checked the documentation of docusaurus but not understand.
choong jianhow
  • 1
  • 2
0
votes
1 answer

Docusaurus beginner : customizing sidebar entries

beginner on docusaurus, I want to start writing doc folders : having autogenerated sidebar by defaut, just trying to remove or rename demonstration folders bring the following error, can't find why Module not found: Error: Can't resolve…
Erwan Pianezza
  • 1
0
votes
1 answer

date offset by 1 in docusaurus blog

I am using docusaurus v2 and created a blog file with the name containing the date I want it to be shown as the post date. However, the date in the generated blog is off by 1 day. Is this something to do with UTC vs local time? How do I make sure…
Siva
  • 1,096
  • 7
  • 20
0
votes
1 answer

passing space preserved code to react component in docusaurus

I have a need to use a custom code editor in docusaurus. I am trying to put together a react component so that I can use the following syntax in the mdx document. return 42; I had problems making this work (which I will explain…
Siva
  • 1,096
  • 7
  • 20
0
votes
1 answer

Docusaurus: Multiple authors in blog post

I'm just concidering a few SSR, and it appears Docusaurus seems to be a good fit. However, there is one feature I'm missing for the Blog, which is multiple authors. As much as I can see, the examples always have one author only. How would it be…
Saurus
  • 1
  • 1
1 2 3
…
31 32