{"id":23765823,"url":"https://github.com/solidusio-contrib/solidus_editor","last_synced_at":"2025-10-08T15:45:17.760Z","repository":{"id":5285071,"uuid":"50882839","full_name":"solidusio-contrib/solidus_editor","owner":"solidusio-contrib","description":":pencil: Adds support for WYSIWYG editors to Solidus","archived":false,"fork":false,"pushed_at":"2023-01-09T08:33:49.000Z","size":1393,"stargazers_count":20,"open_issues_count":2,"forks_count":34,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-10-02T11:44:40.868Z","etag":null,"topics":["ckeditor","solidus","tinymce"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/solidusio-contrib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-02T00:46:45.000Z","updated_at":"2025-01-11T08:50:26.000Z","dependencies_parsed_at":"2023-01-13T13:25:11.018Z","dependency_job_id":null,"html_url":"https://github.com/solidusio-contrib/solidus_editor","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/solidusio-contrib/solidus_editor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio-contrib%2Fsolidus_editor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio-contrib%2Fsolidus_editor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio-contrib%2Fsolidus_editor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio-contrib%2Fsolidus_editor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/solidusio-contrib","download_url":"https://codeload.github.com/solidusio-contrib/solidus_editor/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/solidusio-contrib%2Fsolidus_editor/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278972312,"owners_count":26078017,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ckeditor","solidus","tinymce"],"created_at":"2024-12-31T23:18:09.050Z","updated_at":"2025-10-08T15:45:17.731Z","avatar_url":"https://github.com/solidusio-contrib.png","language":"Ruby","readme":"# Solidus Editor\n\n[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_editor.svg?style=svg)](https://circleci.com/gh/solidusio-contrib/solidus_editor)\n\nThis extension provides an inline rich-text editor for Solidus. It is based off [spree_editor](https://github.com/spree-contrib/spree_editor). It implements different types of editors:\n\n- [CKEditor][1]\n- [TinyMCE][2]\n\nPlease not that this extension is just a simple integration of some pretty complex gems: [`ckeditor`][9] and [`tinymce-rails`][10].\n\nIf you have issues, please check their issues trackers first.\n\n---\n\n## Installation\n\n1. Add the Solidus Editor gem to your `Gemfile`:\n  ```ruby\n  gem 'solidus_editor', github: 'solidusio-contrib/solidus_editor', branch: 'master'\n  ```\n\n2. Run:\n  ```sh\n  $ bundle install\n  $ rails g solidus_editor:install\n  ```\n\n3. If using CKEditor, and would like to enable file uploads run the ckeditor generator:\n  ```sh\n  $ rails g ckeditor:install --orm=active_record --backend=paperclip \u0026\u0026 rake db:migrate\n  ```\n\n4. In order to secure your file uploads to only be accessed by admins you will also need to configure config/initializers/ckeditor.rb:\n  ```ruby\n  config.authorize_with :cancan, Spree::Ability\n  ```\n\n5. In order to precompile CKEditor's generated assets, you will need to add a line in config/initializers/assets.rb:\n  ```ruby\n  Rails.application.config.assets.precompile += %w( ckeditor/*)\n  ```\n---\n\n## Configuration\n\nsolidus\\_editor should be configured inside an initializer\n\n```ruby\n# Required if using solidus_frontend\nSpree::Config[:show_raw_product_description] = true\n\nSpreeEditor::Config.tap do |config|\n  config.ids = 'product_description page_body event_body'\n\n  # change the editor to CKEditor\n  config.current_editor = 'CKEditor'\nend\n```\n\nSolidus itself should be configured to show\n\nThe default values are:\n\n```ruby\nconfig.enabled = true,\nconfig.current_editor = 'TinyMCE',\nconfig.ids = 'product_description page_body'\n```\n\n---\n\n## Language-Support\n\nTo obtain support for multiple languages with TinyMCE add tinymce-rails-langs to your Gemfile:\n\n```ruby\ngem 'tinymce-rails-langs'\n```\n\nTinyMCE will not be loaded unless it finds a language package matching your `Spree::Config.default_locale`.\n\n---\n\nTesting\n-------\n\nFirst bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs, and [Rubocop](https://github.com/bbatsov/rubocop) static code analysis.\n\n```shell\nbundle\nbundle exec rake\n```\n\nWhen testing your application's integration with this extension you may use its factories.\nSimply add this require statement to your spec_helper:\n\n```ruby\nrequire 'solidus_editor/factories'\n```\n\n---\n\nCopyright (c) 2016 [James Whelton][5] and other [contributors][6], released under the [New BSD License][7]\n\n[1]: http://ckeditor.com\n[2]: http://www.tinymce.com\n[3]: http://www.fsf.org/licensing/essays/free-sw.html\n[4]: https://github.com/solidusio-contrib/solidus_editor/issues\n[5]: https://github.com/Whelton\n[6]: https://github.com/solidusio-contrib/solidus_editor/graphs/contributors\n[7]: https://github.com/solidusio-contrib/solidus_editor/blob/master/LICENSE.md\n[8]: https://github.com/solidusio-contrib/v/blob/master/CONTRIBUTING.md\n[9]: https://github.com/galetahub/ckeditor\n[10]: https://github.com/spohlenz/tinymce-rails\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidusio-contrib%2Fsolidus_editor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsolidusio-contrib%2Fsolidus_editor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidusio-contrib%2Fsolidus_editor/lists"}