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
4
votes
0 answers

How to reference files outside of Docusaurus root folder

My team and I are looking to implement a documentation system that allows engineers to put markdown files within a specified folder in each of their service root directories. Since we are in a monorepo, we'd like to have a process that goes through…
TheNastyOne
  • 965
  • 11
  • 19
4
votes
3 answers

How to add icon in the headerLinks in Docusaurus project

To add headerLinks, code is headerLinks: [ { doc: "introduction", label: "Docs" }, { doc: "faq", label: "FAQ" }, { href: "https://github.com", label: "Github", }, { href: "https://example.com", label:…
Amar Somani
  • 63
  • 6
4
votes
1 answer

Is there a way to use Docusaurus just for the /docs directory?

I have an existing website, and just want to use docusaurus to manage the /docs directory (e.g. published as a static site into there). When I follow all the documentation it creates both the docs directory and separate website directory, how can I…
David
  • 167
  • 9
4
votes
1 answer

How to load external (remote) Markdown files into Docusaurus?

Seems like a very basic question, but I could not find an answer in SO, docs or GH issues: We are transferring an existing doc site to Docusaurus V2. Many of our .md files are stored across different GH repos (=different URLs), and we'd like to link…
Ariel Noyman
  • 53
  • 1
  • 8
4
votes
1 answer

docusaurus 2: run custom script for every page

Is it possible to run some custom script for every page? E.g., I want to run alert(1); on every page. How can I do that without the sizzling of any components? I know it can be done by creating jsx component and using it in every .mdx file (but…
Maksim Nesterenko
  • 5,661
  • 11
  • 57
  • 91
4
votes
1 answer

How to integrate dynamic routes in Docusaurus with react-router

I have a website made with Docusaurus v2 that currently contains documentation. However, I would like to add a page of a list of workflows where if a workflow in the list is clicked, the user would be shown a page of additional details of that…
kaytan
  • 41
  • 1
  • 2
4
votes
1 answer

Generating static Docusaurus site for use without without webserver

I have recently started experimenting with Docusaurus and have managed to add pages, menu items etc. I can run the site locally using the following npm run start I have also attempted to build the site using npm run build This seems to require…
BENBUN Coder
  • 4,801
  • 7
  • 52
  • 89
4
votes
1 answer

Docs link broken for Docusaurus v2 project

I am building a documentation site using docusaurus (version 2). It gives a 404 on /docs PAGE NOT FOUND error. Links: My Github Project Netlify hosted site I am new to docusaurus, and I might have misconfigured my /docs. Would appreciate help…
Ayman Arif
  • 1,456
  • 3
  • 16
  • 40
4
votes
1 answer

Change default text color in Docusaurus v2

In Docusaurus v2 I can override the default text color for each class as: .features { display: flex; align-items: center; padding: 2rem 0; width: 100%; color: red; } I don't like this approach because it makes it harder to define…
Dr. Strangelove
  • 2,725
  • 3
  • 34
  • 61
4
votes
1 answer

importing a javascript module in a docusaurus page

On one of the doc/*.md pages in my documentation website I'd like to be able to have a javascript tree view thing. https://github.com/storybookjs/react-treebeard seems like it'd work well but it's not entirely clear to me how I might incorporate…
neubert
  • 15,947
  • 24
  • 120
  • 212
4
votes
1 answer

What's the best practice to fix history.pushState which is deleted by office.js?

Our team wants to build a documentation website that can be opened in browsers and Excel add-ins. We chose Docusaurus V2 as the main framework to build the documentation website, and embedded office.js in it. Office.js deletes history.pushState and…
BurdenBear
  • 71
  • 4
4
votes
2 answers

Custom Search Bar in Docusaurus 2

I'm just experimenting with Docusaurus V2, i want o enable offline search witth LUNR(https://lunrjs.com/) Search, like described, in this blog. https://v2.docusaurus.io/feedback/p/offline-search i also searched the docs for…
dc-deal
  • 322
  • 1
  • 3
  • 12
4
votes
1 answer

How to change the docusaurus browser tab text to match the current page

On a Docusaurus Site, it seems that any page will simply display the site title in the browser tab, but once you get down to the doc level, the browser tab does reflect the title of the page (doc) you are on. Because the title of the doc is what…
Kelsey
  • 61
  • 3
3
votes
1 answer

Custom Tag Page in Docusaurus

I want to create a custom Tag Page for docusaurus. I am using the classic theme and successfully swizzled DocTagDocListPage. So now I can change the template for all tag pages. What I want to do is have a custom markdown page for the route…
niklas
  • 2,887
  • 3
  • 38
  • 70
3
votes
1 answer

Self-hosted deployment of docusaurus on 2 URLs

I am using Docusaurus to provide a User Manual for a web app that is hosted on an AWS EC2 virtual server. The user accesses it through a button on the app. I am trying to set it up so that it will run on three sites without additional configuration…
Nigel
  • 585
  • 1
  • 5
  • 20
1 2
3
…
31 32