DocumentionUmo Editor NextGetting Started

Getting Started

As a commercial software, Umo Editor Next is no longer distributed as a public NPM package. After obtaining a commercial license, you can find the packaged code in our private repository and add Umo Editor Next to your project using the following methods.

View the Integration Example

In addition to the packaged artifacts under /packages, the official packaged-code repository also includes a basic integration example. You can run the example to quickly try it out and use the example code as a reference for integrating Umo Editor Next into your own project.

1. Install Dependencies

Run the following in the packaged-code repository root:

npm install

2. Start the Example

npm run dev

3. Reference the Example Code

The core integration code is located at /src/app.vue. You can refer to this file to learn how to initialize and configure Umo Editor Next in a Vue project.

Using the Official Packaged Code

1. Copy the Packaged Code

Copy the latest packaged file from the /packages directory in the official private repository to your local machine. Assume the local path relative to your project is ./umoteam-editor-next-xxx.tgz.

2. Install Umo Editor Next

Run the following command in your project to install the downloaded packaged file. Make sure to specify the correct file path.

npm install --save ./umoteam-editor-next-xxx.tgz

3. All Set

With the above steps, you have successfully installed the Umo Editor Next NPM dependency and can now use it in your project.

Building It Yourself

You can also build the package yourself by following these steps:

1. Clone the Official Repository

git clone <Umo Editor Next official private repository URL>

2. Install Dependencies and Build the Project Code

npm install
npm run build

3. Install Umo Editor Next

Assume the local repository path you cloned is relative to your project as ../umo-editor-next.

Run the following command in your project to install Umo Editor Next:

npm install --save ../umo-editor-next/packages/umoteam-editor-next-xxx.tgz

4. All Set

With the above steps, you have successfully installed the Umo Editor Next NPM dependency and can now use it in your project.