Redocusaurus
OpenAPI for Docusaurus with Redoc
Overview:
Redocusaurus is a project that combines two packages to easily add API documentation to your documentation site. It includes a Docusaurus Theme Redoc, which is a wrapper around RedocStandalone, and a Docusaurus Plugin Redoc that creates pages from OpenAPI files or URLs. The motivation behind this project is to have documentation and API references in one place with consistent headers and footers.
Features:
- Typed with TypeScript
- Build and Deploy with GitHub branch checks state
- Using Percy.io for visual regression testing
- Combines Docusaurus Theme Redoc and Docusaurus Plugin Redoc
- Provides support for Dark Mode
- Easy integration of API doc(s) into your docs site
- Creates pages from OpenAPI files or URLs
- Showcases multiple OpenAPI specs on the docs website
- Docusaurus
Docusaurus is an open-source static site generator designed for creating documentation websites. Developed by Facebook, it simplifies the process of building, deploying, and maintaining documentation with its React-based framework and pre-configured setup for documentation projects.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
