Glenn Penridge
b6a837b255
* WEBSITE-1582 - News from contentful * WEBSITE-1582 - Removed a couple of unneeded checks * Copied relevant changes from 5x docs. * Added 2x media images. * Fixed device-pixel-ratio issues. * Fixed sync for branch commits. * Typo fixes in README.md
67 lines
1.8 KiB
Markdown
67 lines
1.8 KiB
Markdown
# TinyMCE documentation
|
|
|
|
[](https://app.wercker.com/project/bykey/4d4c743635332430f9d25acae1be5218)
|
|
|
|
This project serves as the documentation for TinyMCE, as you see on
|
|
[http://tinymce.com/docs](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](https://jekyllrb.com/).
|
|
|
|
# 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
|
|
```
|
|
|
|
3. g++. On Fedora, for instance, run:
|
|
|
|
```
|
|
sudo dnf install gcc-c++
|
|
```
|
|
|
|
4. make
|
|
|
|
## First time set up
|
|
|
|
Once you have the prerequisites, 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/](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](https://www.tinymce.com/docs/advanced/contributing-docs/)
|
|
|
|
See the [TinyMCE Docs Wiki](https://github.com/tinymce/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.
|
|
|
|
## Generating API docs from local files
|
|
|
|
```
|
|
npm i -g ephox/moxiedoc#feature/tinymcenext
|
|
./_scripts/api-reference-local.sh ../tinymce
|
|
```
|