docusaurus | Easy to maintain open source documentation websites | Frontend Framework library

by facebook TypeScript Version: v2.4.1 License: MIT

X-Ray Key Features Code Snippets Community Discussions(10)Vulnerabilities Install Support

kandi X-RAY | docusaurus Summary

docusaurus is a TypeScript library typically used in User Interface, Frontend Framework, React, Next.js applications. docusaurus has no bugs, it has no vulnerabilities, it has a Permissive License and it has medium support. You can download it from GitHub.

Docusaurus is a project for building, deploying, and maintaining open source project websites easily.

Support

Quality

Security

License

Reuse

Support

docusaurus has a medium active ecosystem.

It has 45407 star(s) with 7026 fork(s). There are 377 watchers for this library.

There were 1 major release(s) in the last 12 months.

There are 238 open issues and 2411 have been closed. On average issues are closed in 138 days. There are 57 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of docusaurus is v2.4.1

Quality

docusaurus has 0 bugs and 0 code smells.

Security

docusaurus has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

docusaurus code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

docusaurus is licensed under the MIT License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

docusaurus releases are available to install and integrate.

Installation instructions, examples and code snippets are available.

It has 2521 lines of code, 0 functions and 793 files.

It has low code complexity. Code complexity directly impacts maintainability of the code.

Top functions reviewed by kandi - BETA

kandi's functional review helps you automatically verify the functionalities of the libraries and avoid rework.
Currently covering the most popular Java, JavaScript and Python libraries. See a Sample of docusaurus

Get all kandi verified functions for this library.

docusaurus Key Features

No Key Features are available at this moment for docusaurus.

docusaurus Examples and Code Snippets

No Code Snippets are available at this moment for docusaurus.

Community Discussions

Trending Discussions on docusaurus

Brief HTTP 404 error on all pages in /docs

Docusaurus 2 App trying to resolve dev dependencies

How can I get ESLint to recognize Docusaurus aliases?

Docusaurus theme/Layout module cannot be found by Jest

Collapse sidebar (Table of Contents, left side) section

Docusaurus: is it possible to use components from NPM packages?

In Docusaurus, is there can I preserve capitalization in anchors created from headings in docs?

Docusaurus 2 inclusion of a video file in a markdown file

Docsearch on subpath '/docs' not scraping side navigation

'docusaurus-start' is not recognized as an internal or external command

QUESTION

Brief HTTP 404 error on all pages in /docs

Asked 2022-Apr-01 at 20:20

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 the pages render properly.

This only happens in the /docs folder. If I click on the home page link I do not see the 404.

I cannot replicate this issue locally. I have tried both yarn start and yarn build/serve and in both cases the app works fine. I do not see any 404s, console errors, etc. The response payload of the 404 is the OOTB Docusaurus page, I have not done any customization to it or how its handled.

Attached is a gif showing the behavior and a screen shot showing that the browser is seeing a hard 404 in my non-localhost environment.

And here's my config file:

...

ANSWER

Answered 2022-Apr-01 at 20:20

I figured it out. It wasn't a Docusaurus problem. The problem was a configuration issue in our CloudFront infrastructure.

Source https://stackoverflow.com/questions/71711287

QUESTION

Docusaurus 2 App trying to resolve dev dependencies

Asked 2021-Dec-09 at 16:25

I have a Docusaurus 2 (using version 2.0.0-beta.9) app where I'm using msw to write a few tests. The tests work fine the problem is that when running npm start (which runs docusaurus start), I'm seeing docusaurus trying to resolve msw dependencies, which does not make sense given I'm only referring to this dependency from test files. Is it possible to exclude the msw dev dependency to be processed by the underlying webpack config own by docusaurus?

Here are the logs

...

ANSWER

Answered 2021-Dec-09 at 15:40

I recommend checking that you don't import msw in your main Docusaurus code. This is relevant only if you're using MSW for mocking in the browser. Nevertheless, a quick Cmd+F in a project's source files should be enough.

If you feel that your test files are processed by Docusaurus build, still check for suspicious imports. That @mswjs/interceptors dependency import does appear from somewhere, so it's likely that there's a code that imports either msw/node or some other module that does. Keep an eye on the imports especially if you're using a custom module structure to enable mocks (i.e. a single mocks/index.js file that returns the correct setupWorker/setupServer based on the importee's environment).

Source https://stackoverflow.com/questions/70260489

QUESTION

How can I get ESLint to recognize Docusaurus aliases?

Asked 2021-Nov-24 at 00:55

The Situation

I'm working on a Docusaurus project which will include some custom components. I'd like to also use ESLint, and in particular the AirBnB config.

When I run the linter on the initially generated Docusaurus project I get a few errors (not unexpected), but these three give me pause:

...

ANSWER

Answered 2021-Nov-24 at 00:55

@theme, @docusaurus, etc aren't actual paths. They are webpack aliases. To prevent ESLint from tripping up on those, you could ignore those in the ESLint settings

Source https://stackoverflow.com/questions/70051976

QUESTION

Docusaurus theme/Layout module cannot be found by Jest

Asked 2021-Nov-09 at 16:48

I am using Docusaurus to build a documentation site. In one of the react plugin page, I am using import Layout from '@theme/Layout'; from https://docusaurus.io/docs/using-themes

However, the module cannot be picked up by Jest when I write tests for production.

...

ANSWER

Answered 2021-Nov-09 at 16:48

I just mock Layout using an empty component since Layout is from docusaurus which doesn't need tests for my project.

In jest.config.js

Source https://stackoverflow.com/questions/69815033

QUESTION

Collapse sidebar (Table of Contents, left side) section

Asked 2021-Nov-03 at 11:32

How can I add the 'Collapse sidebar' button to my own Docusaurus website, as shown below?

...

ANSWER

Answered 2021-Nov-03 at 11:32

Inside your docusaurus.config.js, you need to add the parameter hideableSidebar: true, in the themeConfig category.

EXAMPLE

Source https://stackoverflow.com/questions/69788759

QUESTION

Docusaurus: is it possible to use components from NPM packages?

Asked 2021-Oct-21 at 09:19

I'm currently getting started with Docusaurus. I know that I can write custom components using mdx files (https://docusaurus.io/docs/markdown-features/react), but is it possible to install a React NPM package and use its components?

I tried this with ChakraUI:

...

ANSWER

Answered 2021-Oct-21 at 09:19

Fixed, I just had to create a Root component (https://docusaurus.io/docs/using-themes#wrapper-your-site-with-root) and wrap it with ChakraProvider

Source https://stackoverflow.com/questions/69649119

QUESTION

In Docusaurus, is there can I preserve capitalization in anchors created from headings in docs?

Asked 2021-Oct-19 at 16:42

I'm using Docusaurus to publish documentation for an open source library's API. The headings of my source markdown files correspond to the names of methods and properties for classes in the library. This all works fine.

However, the anchors that are created in the HTML are all lowercase. I want them to respect the capitalization used in the markdown file.

For example, this markdown header:

...

ANSWER

Answered 2021-Oct-18 at 13:55

TL;DR

Inside your project, navigate to the directory node_modules > github-slugger;
Open the index.js file;
Remove the line if (!maintainCase) string = string.toLowerCase()

The function will become something like this:

Source https://stackoverflow.com/questions/69532616

QUESTION

Docusaurus 2 inclusion of a video file in a markdown file

Asked 2021-Sep-23 at 13:51

Using Docusaurus for help documentation. I can include images, gifs, and reference a youtube video (use iframe). But it is not clear to me how to include a video in a markdown file.

I am expecting the video to be in my repo (i.e. src="./assets/my-video.mp4" type=video/mp4").

There has been discussion on this issue, but I have not been able to find a simple example referencing a video.

...

ANSWER

Answered 2021-Sep-23 at 13:51

You need to install the react-player, create a file with .mdx extension and add the video.

1) Install the react-player:

npm install react-player

2) In your file, for example Intro.mdx, insert at the top (bellow the --- if present):

Source https://stackoverflow.com/questions/69179910

QUESTION

Docsearch on subpath '/docs' not scraping side navigation

Asked 2021-Sep-16 at 17:22

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 arise when the Docusaurus build is nested under {baseUrl}/docs.

Why is this being ignored? This is my docsearch config:

...

ANSWER

Answered 2021-Sep-16 at 17:22

Inside your docusaurus.config.js you should set the url parameter with the actual website where you will be hosting your docs. Something like:

Source https://stackoverflow.com/questions/69192612

QUESTION

'docusaurus-start' is not recognized as an internal or external command

Asked 2021-Sep-12 at 11:19

When I type in yarn start in myproject.github.io/websites I get this error:

...

ANSWER

Answered 2021-Sep-12 at 11:19

Doing yarn add docusaurus --dev instead of yarn global add docusaurus-init (which is what https://v1.docusaurus.io/docs/en/tutorial-setup suggests) did the trick.

Maybe yarn global add docusaurus --dev would have been better but alas that is not what I tried.

Source https://stackoverflow.com/questions/69148683

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install docusaurus

Use the initialization cli to create your site:.

Support

We've released Docusaurus because it helps us better scale and supports the many OSS projects at Facebook. We hope that other organizations can benefit from the project. We are thankful for any contributions from the community. Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Find more information at: