@acrolinx/sidebar-interface

Acrolinx Sidebar Interface

This project contains the Acrolinx Sidebar Interface documentation generated from its TypeScript source.

For the most use cases you don't have to use the Acrolinx Sidebar Interface directly, but can use instead the Acrolinx SDKs.

Live Demo

Acrolinx Sidebar Web Live Demo

The Acrolinx Sidebar

The Acrolinx Sidebar is designed to show up beside the window where you edit your content. You use it for checking, reviewing, and correcting your content. To get an impression what the Sidebar looks like in existing integrations, have a look at Get Started With the Sidebar.

Prerequisites

Please contact Acrolinx SDK support for consulting and getting your integration certified. This sample works with a test license on an internal Acrolinx URL. This license is only meant for demonstration and developing purposes. Once you finished your integration, you'll have to get a license for your integration from Acrolinx.

Acrolinx offers different other SDKs, and examples for developing integrations.

Before you start developing your own integration, you might benefit from looking into:

• Getting Started with Custom Integrations,
• the Guidance for the Development of Acrolinx Integrations,
• the Acrolinx SDKs, and
• the Acrolinx Demo Projects.

Installation Via NPM

For the most use cases you don't have to use the Acrolinx Sidebar Interface directly, but can use instead the Acrolinx Sidebar JavaScript SDK.

npm install @acrolinx/sidebar-interface

(Internal Only) Create a new release

Follow the instruction for creating a release in Github

1. Make sure you have updated the version number in the package.json.
2. On GitHub, navigate to the main page of the repository.
3. To the right of the list of files, click Releases or Latest release.
4. Click Draft a new release.
5. Type a version number for your release.
6. Use the drop-down menu to select the master branch for the release.
7. Add title and description.
8. If you're ready to publicize your release, click Publish release.
9. Github Workflow will take care of publishing the new version to npm.

License

Copyright 2016-present Acrolinx GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

For more information visit: https://www.acrolinx.com