TinyMCE Documentation
Clone or download
idooo Merge pull request #790 from tinymce/feature/DX-903
DX-903 refactoring for deploy branch and robots.txt
Latest commit df7455e Oct 10, 2018
Permalink
Failed to load latest commit information.
_data Added links to 2nd level index pages Oct 4, 2018
_includes Removed API Reference concat from body contents template Oct 5, 2018
_layouts first version fo tinydrive demo page Sep 26, 2018
_plugins DX-874 Restored linking headers anchors Oct 4, 2018
_scripts DX-903 refactoring for deploy branch and robots.txt Oct 10, 2018
advanced fixed demo, it was throwing an error because the wrong property was p… Oct 2, 2018
cloud-deployment-guide change cloud docs to coming soon, we are not avail on cloud for dev p… Oct 1, 2018
components Fix broken links and other edits Oct 5, 2018
configure remove deleted api properties or update config to new Sep 28, 2018
demo add demos for split button, toolbar button, menu button Oct 1, 2018
enterprise Typo in MoxieManager brand Sep 26, 2018
general-configuration-guide Cleanup Oct 2, 2018
images update screen shot Oct 1, 2018
integrations Edits Sep 26, 2018
migration-from-4.x Merge pull request #775 from tinymce/feature/migration-menu-fix Oct 2, 2018
plugins remove sections that are no longer supported in 5x Oct 3, 2018
release-notes add type description Oct 9, 2018
.api-version TINY-1820: bumped version of api import and changed the path to inclu… Sep 26, 2018
.dockerignore moved build system to wercker Dec 1, 2015
.gitignore Add line space before Note in Step 3 Jun 4, 2018
Dockerfile Ephox -> Tiny for all trivial cases Aug 29, 2018
Gemfile DOC-109: Run code examples in the docs website, with button to post t… Sep 26, 2018
Gemfile.lock DOC-109: Run code examples in the docs website, with button to post t… Sep 26, 2018
Makefile DX-738 empty commit Sep 5, 2018
README.md Removed API Reference generator script from Tiny 5 Oct 2, 2018
_config-local.sample.yml Exclusions for speed Jun 12, 2018
_config.yml update cloud front cdn to server codepen source Sep 28, 2018
changelog.md Merge tag 'vpath-fix' into develop Sep 14, 2018
index.md Update to docs homepage Sep 26, 2018
mobile.md update mobile config docs Oct 1, 2018
nixpin.nix DOC-109: Run code examples in the docs website, with button to post t… Sep 26, 2018
pages.json fixe api reference search and layout Nov 10, 2015
quick-start.md Cleanup Oct 2, 2018
search-db.json Also from search-db Oct 5, 2018
shell.nix DOC-109: Run code examples in the docs website, with button to post t… Sep 26, 2018
wercker.yml DX-903 refactoring for deploy branch and robots.txt Oct 10, 2018

README.md

TinyMCE documentation

wercker status

This project serves as the documentation for TinyMCE, as you see on http://tinymce.com/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.

Working on TinyMCE documentation

Prerequisites

You need the following installed on your computer:

  1. Ruby version 2 or later.

  2. Bundler. This can be installed via:

gem install bundler
  1. g++. On Fedora, for instance, run:
sudo dnf install gcc-c++
  1. make

First time set up

Once you have the prerequisites

Then retrieve and init the project:

git clone git@github.com:tinymce/tinymce-docs.git
cd tinymce-docs
./_scripts/init.sh

Run development version

./_scripts/serve.sh

Navigate to http://127.0.0.1:4000/

Contributing to TinyMCE

If you would like to contribute to the TinyMCE project please read the Contributor's Guide

See the TinyMCE Docs Wiki for additional information, including information on troubleshooting the "first time set up" process.

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.