Skip to main content

Migrating from Docusaurus

WriteDocs simplifies documentation management by reducing complex configurations into a single config.json file and supporting .mdx for pages. Follow these steps to migrate your project from Docusaurus to WriteDocs.

  1. Sign up for WriteDocs: Visit WriteDocs and create an account if you don’t already have one.

  2. Create a new project: After logging in, create a new WriteDocs project from the dashboard. Provide the necessary details such as the project name and initial setup preferences.

  3. Clone your project: Once your project is created, clone it to your local machine.

  4. Install the WriteDocs CLI: WriteDocs CLI is essential for managing your documentation locally and generating API reference pages. Install it globally via npm:

    npm install -g writedocs

  5. Migrate .mdx files: WriteDocs supports .mdx files like Docusaurus. Move your .mdx files from the docs/ folder in your Docusaurus project to the docs/ folder in your WriteDocs project.

  6. Set up the config.json: Reflect the files path and your branding using our configuration file. WriteDocs uses a single config.json file for all configurations, replacing the complex setup of Docusaurus.

  7. Generate API reference pages (Optional): If you have an OpenAPI specification, you can generate API reference pages by checking API Pages.

  8. Run and preview your documentation:

    writedocs dev