dpatz / tinymce-docs

TinyMCE Documentation

TinyMCE documentation

This project maintains the documentation for TinyMCE at https://www.tiny.cloud/docs. If you have any modifications you wish to contribute, fork this project, make the changes and submit a pull request. You will need to sign the contributors license agreement, which will be emailed to you upon creating the pull request.

This project is built using Jekyll.

Contributing to the TinyMCE Documentation

If you would like to contribute to the TinyMCE project please read the TinyMCE Documentation Contributor's Guide at either:

• TinyMCE Documentation - Contributor's Guide.
• GitHub - Contributing to the TinyMCE developer documentation.

Working on TinyMCE documentation

Compiling or building the documentation

The following procedure assists with building (or compiling) the documentation locally. Tiny recommends testing and reviewing changes locally prior to submitting a pull request.

Installing Prerequisites

Linux users

You need the following programs installed on your computer:

• Ruby version 2 or later. To verify the installed version, run:

  ruby --version
  

1. Install git, g++, make, and the zlib development files. For example:

   • On Fedora, run:

     sudo dnf install git-all gcc-c++ make zlib-devel
     

   • On Ubuntu, Debian or their derivatives, run:

     sudo apt install git gcc cpp make zlib1g-dev
     

2. Install Ruby Nokogiri: https://nokogiri.org/

   sudo gem install nokogiri
   

3. Install Ruby Bundler. Install using:

   sudo gem install bundler
   

4. (optional) Docker

Windows users

If you are a Windows user, follow these steps to work on TinyMCE documentation:

1. Install git for Windows.

2. Install Ruby+Devkit.

3. Run the following command on a command prompt to install Ruby Bundler:

   gem install bundler
   

Mac OS users

1. Ruby version 2 or later is required. Verify the pre-installed version, using:

   ruby --version
   

2. Install Ruby Bundler, using:

   gem install bundler
   

First time set up

Once you have installed any missing prerequisites, in a terminal or on a command prompt:

1. Clone the git repository:

   git clone [e-mail]:tinymce/tinymce-docs.git
   

2. Change directory into the cloned git repository:

   cd tinymce-docs
   

3. Run the initialization script to install dependencies and create the required local files in the git repository:

   ./_scripts/init.sh
   

Run the development version of the documentation

To create a development version of the documentation, run:

./_scripts/serve.sh

Allow the serve.sh script to run in the background while you are working on the TinyMCE documentation.

To view the documentation; in a web browser, navigate to http://localhost:4000/.

Note: The development version of the documentation will update automatically when you save changes locally.

TinyMCE API documentation

The TinyMCE API documentation is maintained within the TinyMCE project repository and compiled for the documentation site using MoxieDoc.

Prerequisites

• NodeJS.
• The TinyMCE documentation repository set up for development as described in Installing Prerequisites and First time set up.

Installing MoxieDoc

To install MoxieDoc, run:

npm install -g git://github.com/tinymce/moxiedoc.git#feature/tinymcenext

Run the development version of the documentation for the current TinyMCE version

1. Download the TinyMCE version in the .api-version file in this project's root directory and extract the API documentation using:

    ./_scripts/api-reference.sh

2. Start the development server using:

    ./_scripts/serve.sh

Run the development version of the documentation for a local TinyMCE repository

1. Extract the API documentation from a local copy of the TinyMCE repository using:

    ./_scripts/api-reference-local.sh <path/to/the/tinymce/repo>

2. Start the development server using:

    ./_scripts/serve.sh

3. To include updates made to the TinyMCE API documentation in the TinyMCE repository, run the api-reference-local script:

    ./_scripts/api-reference-local.sh <path/to/the/tinymce/repo>

Note: The development server does not need to be stopped prior to running the api-reference-local script.

Codepens

Codepens can be added to content using the "codepen.html" include, such as:

{% include codepen.html id="basic-example" %}

There are several options for this include file - please see codepen.html for details.

The source for each CodePen is store in the _includes/codepens/ directory.

Overriding the tinymce URL in codepens

All codepens usually get their tinymce.min.js URL from the codepen_url setting in the _config.yml file. However, there are some instances where you wish to override this, e.g.

• You want to push/deploy a branch for a new feature that's only on the 'dev' channel.
• You want to run the site locally, but test out the codepens in a different channel.

To help with this, there are two mechanisms for overriding the tinymce.min.js URL.

1. Set codepen_url in _config-local-override.yml.

   • This will override the codepen_url setting in config.yml.
   • This file is not intended to be checked in.
   • This option changes the URL for all codepens.

2. Set the script_url_override setting when including codepen.html.

   • This is useful if you want to deploy the develop branch for a feature only in the 'dev' channel.
   • This only overrides the URL for one codepen.
   • Don't use this in more than one codepen on a page.
   • Don't use this long-term - when the feature is fully rolled-out, use the standard channel.
   • See codepen.html for details.

Note: Jekyll is pretty bad at automatically reloading code when you're playing with include files. Sometimes you need to restart the server.

Why is HTML minification disabled?

It's very slow and the minifier is using regex to parse HTML. We may add a different minifier in the future.