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
2 answers

Change base /docs/ path to /home/ | Docusaurus

I am trying to rename the default docs path to home so that all the "documentation" files will be found under the home directory like home/doc1. So, I followed this guide: https://docusaurus.io/docs/docs-multi-instance and changed up my…
aakhilv
  • 123
  • 2
  • 11
0
votes
1 answer

Unable to run Algolia Docsearch in my docusaurus v2 website

I have received my algolia apiKey and the indexName, I have correctly added them under themeConfig in my docusauras.config.js file algolia: { apiKey: 'API_KEY', indexName: 'INDEX_NAME', }, However, my docsearch is not working. I…
Tarun Singh
  • 430
  • 8
  • 18
0
votes
1 answer

Building page with asynchronous react component does not render the latest iteration when building the documentation

I've been migrating my documentation from Jekyll to docusaurus V2. Context I need to fetch data from a CSV file to display them as a table in the documentation. To that end, I've created a custom react component that fetches and format the…
Alroc
  • 125
  • 1
  • 12
0
votes
1 answer

Docusaurus language dropdown display issue

I am using Docusaurus i18n integration to add the language dropdown to site, but it shows weired enter image description here How can I handle this issue
jyfocus
  • 1
0
votes
1 answer

Page Not Found in Docusaurus

I'm trying to add add a new page in Docusaurus v2, so I added a new item in the navbar: module.exports = { ... themeConfig: { navbar: { title: 'My Site: API Documentation', logo: { alt: 'My Site Logo', src:…
Jacob Krieg
  • 2,834
  • 15
  • 68
  • 140
0
votes
1 answer

Changing position of announcement bar?

I've been using Docusaurus v2 with the default theme for my Python library website and love it! I'd like to change the position of the announcement bar, which is currently at the top of the page, as it isn't very visible. I think it would work…
stefanwebb
  • 11
  • 2
0
votes
1 answer

User '/reference' instead of '/docs' for the docs plugin

Is it possible to to use http://localhost:3000/reference/ or any other path instead of http://localhost:3000/docs/ to point to the documentation *.md structure? I configured the preset-classic inside docusaurus.config.js like this: module.exports =…
Jacob Krieg
  • 2,834
  • 15
  • 68
  • 140
0
votes
1 answer

Split view using docusaurus

I'm trying to achieve something like this: example image here Is there a way to do this using docusaurus?
Mido
  • 89
  • 1
  • 10
0
votes
1 answer

how can custom scripts be added in index.html's head part in docusaurus

I created a scripts folder inside static and added a custom js file called "GetLocation.js" and here is the path for it project/website/static/scripts/GetLocation.js I see there is a place in siteconfig.js to add custom scripts and adding it here…
Yoda
  • 319
  • 2
  • 5
  • 20
0
votes
2 answers

Docusaurus build missing fonts

I load the custom font with the location in the static/fonts folder, it works fine when in development mode (docusaurus start), but when I build (docusaurus build), the results show that the fonts I used are not loading, because the fonts folder is…
SupianIDz
  • 3
  • 3
0
votes
1 answer

Docusaurus v2 -- how to change images for darkMode

I'm not very good with javascript so I don't know how to make a image to change in darkMode. theese images are SVG, and are in the index.js, not in the markdowns. I've been looking for a way, but the Docusaurus documentation only says how to change…
Ignacio Díaz R.
  • 11
  • 3
0
votes
2 answers

custom domain keeps on getting removed every time i do a deployment

I’m using Docusaurus / Travis CI to build my docs and I’m trying to have them hosted on a custom domain - myproject.com. The way I have it setup right now Travis CI initiates a build every time I do a commit BUT the custom domain gets wiped out…
neubert
  • 15,947
  • 24
  • 120
  • 212
0
votes
1 answer

making it so docusaurus uploads to subdirectory instead of web root

From node_modules\docusaurus\lib\publish-gh-pages.js: const websiteURL = GITHUB_HOST === GITHUB_DOMAIN ? `https://${ORGANIZATION_NAME}.github.io/${PROJECT_NAME}` // gh-pages hosted repo :…
neubert
  • 15,947
  • 24
  • 120
  • 212
0
votes
1 answer

setting up continuous deployment via travis ci for docusaurus - what github scopes to use?

According to https://docusaurus.io/docs/en/publishing#using-travis-ci in order to use Travis CI to do continuous deployments to github pages you need to "Go to https://github.com/settings/tokens and generate a new personal access token". When I do…
neubert
  • 15,947
  • 24
  • 120
  • 212
0
votes
1 answer

Hook into React Router events in Docusarus?

I'm trying to integrate a simple image zooming library. Basically when clicking on an image, it's expanded so that user can see the image better. Something like this: https://kingdido999.github.io/zooming/ My attempt is to create a plugin that…
huy
  • 4,782
  • 6
  • 36
  • 42
1 2 3
…
31 32