Editsaurus

What Editsaurus is

Editsaurus is a visual editor for Docusaurus documentation. It lets users open a local Docusaurus site in a browser, click text on the page, and edit it directly. A real-time preview shows the changes as they are made. Editsaurus automatically saves and syncs those edits to the corresponding Markdown files in the project, using `.md` or `.mdx` files. It runs alongside the local site as an extension to Docusaurus. To start, run `npx editsaurus` from the root of an existing Docusaurus project. The project requires Node.js version 18 or higher, and Editsaurus says it aims to support recent Docusaurus versions. Its Free plan costs nothing and includes all features. Editsaurus describes itself as open source and community driven, and presents its role as an extension rather than an intrusive dependency. The browser-based editing workflow is focused on documentation already maintained in Docusaurus, with the project and Node.js prerequisites in place.

Who it suits

Editsaurus suits people maintaining documentation in an existing Docusaurus project who want to edit page text in the browser and preview changes as they work. It is also a fit for users who want edits saved directly to the project's Markdown or MDX files.

Limits

The Free plan costs nothing and includes all features. It requires an existing Docusaurus project and Node.js version 18 or higher.

Getting started

1. Create or use an existing Docusaurus project.
2. Make sure Node.js version 18 or higher is available.
3. From the project root, run `npx editsaurus`.
4. Open the local Docusaurus site in a browser.
5. Click documentation text to edit it and review the real-time preview.

Verdict

Choose Editsaurus if you maintain a Docusaurus project and want to edit its documentation in the browser while seeing a live preview. Its free plan includes all features, while its use depends on an existing project and Node.js version 18 or higher.