{"id":20438444,"url":"https://github.com/tinymce/tinymce-docs-4x","last_synced_at":"2025-12-01T19:06:11.100Z","repository":{"id":33859334,"uuid":"149365542","full_name":"tinymce/tinymce-docs-4x","owner":"tinymce","description":"TinyMCE Documentation (version 4)","archived":false,"fork":false,"pushed_at":"2024-10-28T15:18:42.000Z","size":25727,"stargazers_count":5,"open_issues_count":2,"forks_count":15,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-01-15T19:54:57.589Z","etag":null,"topics":["documentation","tinymce-documentation"],"latest_commit_sha":null,"homepage":"https://www.tiny.cloud/docs/","language":"HTML","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":"changelog.md","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}},"created_at":"2018-09-18T23:47:59.000Z","updated_at":"2024-11-07T12:17:58.000Z","dependencies_parsed_at":"2024-11-15T09:11:10.180Z","dependency_job_id":"4a8e173e-b8d2-426c-80ac-902bc3c71f8f","html_url":"https://github.com/tinymce/tinymce-docs-4x","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinymce%2Ftinymce-docs-4x","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinymce%2Ftinymce-docs-4x/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinymce%2Ftinymce-docs-4x/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tinymce%2Ftinymce-docs-4x/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tinymce","download_url":"https://codeload.github.com/tinymce/tinymce-docs-4x/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241983604,"owners_count":20052711,"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":["documentation","tinymce-documentation"],"created_at":"2024-11-15T09:11:05.285Z","updated_at":"2025-12-01T19:06:06.060Z","avatar_url":"https://github.com/tinymce.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TinyMCE Documentation\n\nThis project maintains the documentation for TinyMCE at\n[https://www.tiny.cloud/docs-4x/](https://www.tiny.cloud/docs-4x/). If you have any\nmodifications you wish to contribute, fork this project, make the changes\nand submit a pull request. You will need to sign the contributors license\nagreement, which will be emailed to you upon creating the pull request.\n\nThis project is built using [Jekyll](https://jekyllrb.com/).\n\n## Contributing to the TinyMCE Documentation\n\nIf you would like to contribute to the TinyMCE project please read the TinyMCE Documentation Contributor's Guide at either:\n\n- [TinyMCE Documentation - Contributor's Guide](https://www.tiny.cloud/docs-4x/advanced/contributing-docs/).\n- [GitHub - Contributing to the TinyMCE developer documentation](https://github.com/tinymce/tinymce-docs-4x/blob/develop/CONTRIBUTING.md#contributing-to-the-tinymce-developer-documentation).\n\n## Working on TinyMCE documentation\n\n### Compiling or building the documentation\n\nThe following procedure assists with building (or compiling) the documentation locally. Tiny recommends testing and reviewing changes locally prior to submitting a pull request.\n\n#### Installing Prerequisites\n\n##### Linux users\n\nYou need the following programs installed on your computer:\n\n- Ruby version 2 or later. To verify the installed version, run:\n  ```\n  ruby --version\n  ```\n\n1. Install git, g++, `make`, and the zlib development files. For example:\n    - On Fedora, run:\n\n      ```\n      sudo dnf install git-all gcc-c++ make zlib-devel\n      ```\n    - On Ubuntu, Debian or their derivatives, run:\n      ```\n      sudo apt install git gcc cpp make zlib1g-dev\n      ```\n\n2. Install Ruby Nokogiri: https://nokogiri.org/\n    ```\n    sudo gem install nokogiri\n    ```\n\n3. Install Ruby Bundler. Install using:\n    ```\n    sudo gem install bundler\n    ```\n\n4. (optional) Docker\n\n##### Windows users\n\nIf you are a Windows user, follow these steps to work on TinyMCE documentation:\n\n1. Install [git for Windows](https://gitforwindows.org/).\n\n2. Install [Ruby+Devkit](https://rubyinstaller.org/downloads/).\n\n3. Run the following command on a command prompt to install Ruby Bundler:\n    ```\n    gem install bundler\n    ```\n\n##### Mac OS users\n\n1. Ruby version 2 or later is required. Verify the pre-installed version, using:\n    ```\n    ruby --version\n    ```\n\n2. Install Ruby Bundler, using:\n    ```\n    gem install bundler\n    ```\n\n#### First time set up\n\nOnce you have installed any missing prerequisites, in a terminal or on a command prompt:\n\n1. Clone the git repository:\n    ```\n    git clone git@github.com:tinymce/tinymce-docs.git\n    ```\n\n2. Change directory into the cloned git repository:\n    ```\n    cd tinymce-docs\n    ```\n\n3. Run the initialization script to install dependencies and create the required local files in the git repository:\n    ```\n    ./_scripts/init.sh\n    ```\n\n#### Run the development version of the documentation\n\nTo create a development version of the documentation, run:\n\n```\n./_scripts/serve.sh\n```\n\nAllow the `serve.sh` script to run in the background while you are working on the TinyMCE documentation.\n\nTo view the documentation; in a web browser, navigate to [http://localhost:4000/](http://localhost:4000/).\n\n\u003e **Note**: The development version of the documentation will update automatically when you save changes locally.\n\n#### TinyMCE API documentation\n\nThe TinyMCE API documentation is maintained within the [TinyMCE project repository](https://github.com/tinymce/tinymce) and compiled for the documentation site using [MoxieDoc](https://github.com/tinymce/moxiedoc).\n\n##### Prerequisites\n\n- [NodeJS](https://nodejs.org/en/).\n- The TinyMCE documentation repository set up for development as described in [Installing Prerequisites](#installing-prerequisites) and [First time set up](#first-time-set-up).\n\n##### Installing MoxieDoc\n\nTo install MoxieDoc, run:\n\n```\nnpm install -g git://github.com/tinymce/moxiedoc.git\n```\n\n##### Run the development version of the documentation for the current TinyMCE version\n\n1. Download the TinyMCE version in the `.api-version` file in this project's root directory and extract the API documentation using:\n```\n    ./_scripts/api-reference.sh\n```\n\n2. Start the development server using:\n```\n    ./_scripts/serve.sh\n```\n\n##### Run the development version of the documentation for a local TinyMCE repository\n\n1. Extract the API documentation from a local copy of the TinyMCE repository using:\n```\n    ./_scripts/api-reference-local.sh \u003cpath/to/the/tinymce/repo\u003e\n```\n2. Start the development server using:\n```\n    ./_scripts/serve.sh\n```\n3. To include updates made to the TinyMCE API documentation in the TinyMCE repository, run the `api-reference-local` script:\n```\n    ./_scripts/api-reference-local.sh \u003cpath/to/the/tinymce/repo\u003e\n```\n\n\u003e**Note**: The development server does not need to be stopped prior to running the `api-reference-local` script.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftinymce%2Ftinymce-docs-4x","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftinymce%2Ftinymce-docs-4x","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftinymce%2Ftinymce-docs-4x/lists"}