{"id":20438421,"url":"https://github.com/tinymce/tinymce-docs","last_synced_at":"2026-01-26T22:54:42.197Z","repository":{"id":38240431,"uuid":"43335308","full_name":"tinymce/tinymce-docs","owner":"tinymce","description":"TinyMCE Documentation","archived":false,"fork":false,"pushed_at":"2026-01-20T06:37:30.000Z","size":59128,"stargazers_count":94,"open_issues_count":12,"forks_count":221,"subscribers_count":31,"default_branch":"main","last_synced_at":"2026-01-20T11:29:13.773Z","etag":null,"topics":["documentation","documentation-site","tinymce","tinymce-documentation"],"latest_commit_sha":null,"homepage":"https://www.tiny.cloud/docs/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tinymce.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2015-09-29T00:33:45.000Z","updated_at":"2026-01-19T12:42:00.000Z","dependencies_parsed_at":"2023-02-11T22:15:52.416Z","dependency_job_id":"aac994cb-482e-422b-b3e9-b381b0d1ec3e","html_url":"https://github.com/tinymce/tinymce-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tinymce/tinymce-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinymce%2Ftinymce-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinymce%2Ftinymce-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinymce%2Ftinymce-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinymce%2Ftinymce-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tinymce","download_url":"https://codeload.github.com/tinymce/tinymce-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinymce%2Ftinymce-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28791162,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T21:49:50.245Z","status":"ssl_error","status_checked_at":"2026-01-26T21:48:29.455Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["documentation","documentation-site","tinymce","tinymce-documentation"],"created_at":"2024-11-15T09:10:58.967Z","updated_at":"2026-01-26T22:54:42.191Z","avatar_url":"https://github.com/tinymce.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# TinyMCE Documentation\n\nThis project maintains the official documentation for TinyMCE, available at [https://www.tiny.cloud/docs](https://www.tiny.cloud/docs). If you have modifications or improvements to contribute, fork this repository, make the necessary changes, and submit a pull request (PR). A contributor's license agreement (CLA) must be signed before your contribution can be merged. This agreement will be sent via email when you create a PR.\n\nThis project is built using [Antora](https://antora.org/)\n\n## Contributing to the TinyMCE Documentation\n\nTo contribute to the TinyMCE documentation project, please review the following resources:\n\n- [GitHub - How to contribute to TinyMCE’s documentation](https://github.com/tinymce/tinymce-docs/blob/main/CONTRIBUTING.md#how-to-contribute-to-tinymces-documentation)\n\nThese guides cover contribution guidelines, project structure, style conventions, and best practices for submitting changes.\n\n## Setting Up Your Development Environment\n\nTo contribute effectively, you should set up a local development environment. This allows you to preview and test your changes before submitting a PR.\n\n### Prerequisites\n\nEnsure the following software is installed:\n\n- [Node.js](https://nodejs.org/en/) (version 22.9 or lower)\n- [Yarn](https://yarnpkg.com/)\n- Git\n\n### Cloning the Repository\n\nClone the TinyMCE documentation repository:\n\n```bash\ngit clone git@github.com:tinymce/tinymce-docs.git\ncd tinymce-docs\nyarn\n```\n\n### Running the Development Server\n\nTo build and serve the documentation locally:\n\n```bash\nyarn build\nyarn start-dev\n```\n\nVisit [http://127.0.0.1:4000](http://127.0.0.1:4000) to view the documentation. The server supports hot-reloading, so changes will automatically reflect when you save your work.\n\n\u003e **Note:** The `yarn build` command generates the API reference documentation from the TinyMCE source code. To adjust the API version, edit the `API_VERSION` variable in the `scripts/api-reference.sh` file. Alternatively, use `yarn build-local` to build using a local TinyMCE instance:\n\nExample:\n\n```bash\nyarn build-local ../path/to/local/tinymce\n```\n\n### API Documentation\n\nThe TinyMCE API documentation is compiled and generated using [MoxieDoc](https://github.com/tinymce/moxiedoc) from the core [TinyMCE project repository](https://github.com/tinymce/tinymce). To update the published API docs:\n\n1. Update the `.api-version` file.\n2. Run `yarn build`:\n\n   * Running `yarn build` downloads the TinyMCE package specified in `.api-version` and generates new API reference content from source.\n3. Commit the changes.\n\n\u003e **Warning:** The API documentation should not be edited manually. Always generate it from source to ensure accuracy.\n\n## Live Demos\n\nLive demos can be added to the `modules/ROOT/examples/live-demos` directory. Reference them in your documentation with:\n\n```asciidoc\nliveDemo::{sub-directory-name}[]\n```\n\n### Overriding the TinyMCE URL in Live Demos\n\nBy default, live demos load TinyMCE from the URL specified in the `tinymce_live_demo_url` attribute in the `antora.yml` file. This can be overridden for specific use cases:\n\n* Testing a new feature on the `dev` channel.\n* Running the site locally while testing live demos on a different channel.\n\nTo help with this, there are two mechanisms for overriding the `tinymce.min.js` URL:\n\n1. **Global Override:**\n   To change the TinyMCE URL for all live demos, modify the `tinymce_live_demo_url` attribute in `antora-playbook-dev.yml`:\n\n   ```yaml\n   asciidoc:\n     attributes:\n       tinymce_live_demo_url: https://your-custom-url.com/tinymce.min.js\n   ```\n\n2. **Per-Demo Override:**  Use the `script_url_override` attribute:\n   To override the URL for a specific live demo:\n\n   ```asciidoc\n   liveDemo::{sub-directory-name}[script_url_override='https://your-custom-url.com/tinymce.min.js']\n   ```\n\n\u003e **Caution:** Use this sparingly. Avoid using different URLs for multiple demos on the same page, and remember to revert these changes once the feature is fully released.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftinymce%2Ftinymce-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftinymce%2Ftinymce-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftinymce%2Ftinymce-docs/lists"}