Garden RTE Resources

🌱 Garden is the design system by Zendesk

This package provides Garden theme customizations for the @ckeditor/ckeditor5-theme-lark package.

Installation

npm install --save-dev @zendeskgarden/ckeditor

Usage

When building editors from source, ensure that any webpack configurations also include the Garden package.

{
  test: [/ckeditor5-[^/\\]+[/\\]theme[/\\].+\.css$/, /zendeskgarden[\/\\]ckeditor[\/\\].+[\/\\]theme[\/\\].+\.css$/],
  use: [
      {
        loader: 'style-loader'
      },
      {
        loader: 'postcss-loader',
        options: styles.getPostCssConfig( {
            themeImporter: {
                themePath: require.resolve('@ckeditor/ckeditor5-theme-lark')
            }
        })
      },
  ]
}

Then include the theme overrides in your application.

import '@zendeskgarden/ckeditor';

Contribution

Thanks for your interest in Garden! Community involvement helps make our design system fresh and tasty for everyone.

Got issues with what you find here? Please feel free to create an issue.

Community behavior is benevolently ruled by a code of conduct. Please participate accordingly.

License

Copyright 2021 Zendesk

Licensed under the Apache License, Version 2.0

Some of the code included in this Zendesk repo may depend upon software authored and provided by CKSource Frederico Knabben. The terms and conditions of the Apache license do not extend to software provided by CKSource, which may be provided under different licenses. Please see the CKEditor Software License Agreement for additional information.