{"id":20779233,"url":"https://github.com/bolt/redactor","last_synced_at":"2025-10-15T00:32:07.162Z","repository":{"id":43724712,"uuid":"282235359","full_name":"bolt/redactor","owner":"bolt","description":"📝 Bolt Extension to add the Redactor FieldType","archived":false,"fork":false,"pushed_at":"2024-07-29T16:02:41.000Z","size":766,"stargazers_count":11,"open_issues_count":3,"forks_count":12,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-01-24T15:06:41.260Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bolt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-24T14:05:15.000Z","updated_at":"2024-03-11T10:45:42.000Z","dependencies_parsed_at":"2024-06-19T00:21:57.873Z","dependency_job_id":"fb2a1017-2c06-421a-924c-21e46627cbcf","html_url":"https://github.com/bolt/redactor","commit_stats":{"total_commits":78,"total_committers":6,"mean_commits":13.0,"dds":"0.14102564102564108","last_synced_commit":"c4378d41146a9362ce1011d8235c4339247af312"},"previous_names":[],"tags_count":48,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bolt%2Fredactor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bolt%2Fredactor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bolt%2Fredactor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bolt%2Fredactor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bolt","download_url":"https://codeload.github.com/bolt/redactor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236541946,"owners_count":19165764,"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","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":[],"created_at":"2024-11-17T13:26:44.652Z","updated_at":"2025-10-15T00:32:01.813Z","avatar_url":"https://github.com/bolt.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📝 Bolt Redactor Extension\n\nThis extension provides a \"Redactor\" field type, which is a sophisticated,\nlightweight and elegant WYSIWYG editor component for\n[Bolt](https://boltcms.io). The editor itself is developed by\n[Imperavi][redactor], and is licensed for usage in Bolt.\n\nThis extension allows you to add fields of `type: redactor` in your\nContentTypes, as defined in `contenttypes.yaml`, like any other Field type.\n\n## Installation\n\nNote: Installation is not required if you've installed the default Bolt\nproject. In that case it's already present. If you've installed Bolt through\ndifferent means, you'll need to run the command below:\n\n```bash\ncomposer require bolt/redactor\n```\n\nAfter installation, you can add it to any ContentType in your\n`contenttypes.yaml`, like any other field. For example:\n\n```yaml\nblogposts:\n    name: Blogposts\n    singular_name: Blogpost\n    fields:\n        title:\n            type: text\n        slug:\n            type: slug\n            uses: title\n        content:\n            type: redactor\n```\n\nThe result will be like this:\n\n![](https://user-images.githubusercontent.com/1833361/90637112-dbf59f80-e22b-11ea-8bfd-574b72a79fdc.png)\n\nYou can configure the editor in `config/extensions/bolt-redactor.yaml`. This\nconfiguration affects all the instances of the Redactor field that you've\nconfigured in your ContentTypes. The default configuration looks like this:\n\n```yaml\ndefault:\n  buttons: [ bold, italic, format, lists, link, html, image ]\n  plugins: [ fullscreen, table, inlinestyle, video, widget ]\n  source: true\n\nplugins:\n  ~\n```\n\n## Configuring the buttons\n\nBolt's version of Redactor ships with all the official plugins and options. you\ncan add or remove buttons by configuring them in the `buttons:` and `plugins:`\nparameters. Check the official Redactor documentation for [all available\nbuttons][buttons]. Note that some buttons might require you to enable the\ncorresponding plugin as well. See here for a list of\n[the available plugins][plugins].\n\n## Settings\n\nWhere applicable, you can add extra settings under the `default:` key in the\n`bolt-redactor.yaml` configuration. See the documentation for available\nsettings.\n\nNote that this documentation uses Javascript, whilst Bolt's configuration uses\nYaml. For example, the documentation for '[Paste][paste]' has this example:\n\n```javascript\n$R('#content', {\n        pastePlainText: true\n});\n```\n\nIn `bolt-redactor.yaml` you can add this as:\n\n```yaml\ndefault:\n  buttons: [ …]\n  plugins: [ … ]\n  pastePlainText: true\n```\n\n## Adding custom plugins\n\nIf you've written your own plugin for Redactor according to the documentation\n[for Creating Plugins][create-plugin], you can add it to the editor in Bolt, by\nplacing it in `/public/assets/redactor/plugins`. Then, add it to the\n`bolt-redactor.yaml` configuration:\n\n```yaml\ndefault:\n  buttons: [ … ]\n  plugins: [ … ]\n\nplugins:\n  myplugin: [ 'myplugin/myplugin.js', 'myplugin/myplugin.css' ]\n```\n\n-------\n\nThe part below is only for _developing_ the extension. Not required for general\nusage of the extension in your Bolt Project\n\n## Running PHPStan and Easy Codings Standard\n\nFirst, make sure dependencies are installed:\n\n```bash\nCOMPOSER_MEMORY_LIMIT=-1 composer update\n```\n\nAnd then run ECS:\n\n```bash\nvendor/bin/ecs check src --fix\n```\n\n[redactor]: https://imperavi.com/redactor/\n[create-plugin]: https://imperavi.com/redactor/docs/how-to/create-a-plugin/\n[buttons]: https://imperavi.com/redactor/examples/buttons/change-buttons-in-the-toolbar/\n[plugins]: https://imperavi.com/redactor/plugins/\n[paste]: https://imperavi.com/redactor/docs/settings/paste/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbolt%2Fredactor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbolt%2Fredactor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbolt%2Fredactor/lists"}