You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For our Contributor Code of Conduct, visit our https://github.com/tinymce/tinymce-docs-4x/blob/develop/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct[Contributor Covenant Code of Conduct on GitHub].
We welcome people with technical writing experience to help make TinyMCE's docs as useful to our community as possible. Although you don't need to be an expert developer to contribute, a basic understanding of software development is helpful.
@@ -23,13 +22,13 @@ What is more important is your ability to articulate complex ideas. Our goal is
23
22
Simply branch the https://github.com/tinymce/tinymce-docs-4x[docs GitHub repository] and submit a PR, or reach out to the https://github.com/tinymce/tinymce-docs-4x/issues/new?assignees=&labels=question&template=question.md[TinyMCE docs team] if you have a specific question.
The documentation is built with Jekyll. Text files are written in https://kramdown.gettalong.org/[kramdown] and published on https://github.com/tinymce/tinymce-docs-4x[GitHub]. You will find the https://github.com/tinymce/tinymce-docs-4x[repo here].
30
29
31
30
[[markdown--code-syntax]]
32
-
== Markdown & code syntax
31
+
== Markdown & code syntax
33
32
anchor:markdowncodesyntax[historical anchor]
34
33
35
34
The documentation is written in https://kramdown.gettalong.org/[kramdown Flavored Markdown]. If you are not familiar with kramdown https://kramdown.gettalong.org/quickref.html[read this].
@@ -42,7 +41,7 @@ Code language syntax and associated elements are highlighted using an open and c
42
41
Highlight words relating specifically to executable parts of software languages. Keys and their values when pertaining to objects and methods (particularly the case with TinyMCE) should have backticks. We cannot cover every use case here and contributors need to use their best judgment. What is more important is your ability to articulate complex ideas.
43
42
44
43
[[code-snippets]]
45
-
=== Code snippets
44
+
=== Code snippets
46
45
anchor:codesnippets[historical anchor]
47
46
48
47
Code snippets should always be complete, executable code blocks starting with the `tinymce` object. We write code snippets by enclosing the example code within three opening and closing backticks. The first set of backticks is immediately followed by the code's language, which helps correct syntax highlighting: typically, html, css, js (and sometimes php).
@@ -71,7 +70,7 @@ tinymce.init({
71
70
----
72
71
73
72
[[urls-and-links]]
74
-
=== URLs and links
73
+
=== URLs and links
75
74
anchor:urlsandlinks[historical anchor]
76
75
77
76
Resources to be linked take the form of placing the linked text between brackets and the URL between parenthesis. Linking an external resource looks like this:
@@ -94,7 +93,7 @@ There are several options for this include file - please see `_includes/codepen.
94
93
The source for each CodePen is store in the `_includes/codepens/` directory.
95
94
96
95
[[adding-metadata-to-a-page]]
97
-
=== Adding metadata to a page
96
+
=== Adding metadata to a page
98
97
anchor:addingmetadatatoapage[historical anchor]
99
98
100
99
Every page should have a meta section starting at line 1 containing information that is both informative and system critical. If you are creating a page or editing one that currently has inadequate meta information, please read the comments next to the default meta fields below.
@@ -111,17 +110,17 @@ keywords: // Space-separated list of keywords in the content.
111
110
----
112
111
113
112
[[style-guide]]
114
-
== Style Guide
113
+
== Style Guide
115
114
anchor:styleguide[historical anchor]
116
115
117
116
[[tinymce-v-tinymce]]
118
-
=== TinyMCE v. tinymce
117
+
=== TinyMCE v. tinymce
119
118
anchor:tinymcevtinymce[historical anchor]
120
119
121
120
Use the capitalized version of TinyMCE when referring to the open source project or the editor. Use lowercase when referring to the `tinymce` JavaScript object.
122
121
123
122
[[title-capitalization]]
124
-
=== Title capitalization
123
+
=== Title capitalization
125
124
anchor:titlecapitalization[historical anchor]
126
125
127
126
For titles use "Sentence case capitalization". Sentence case capitalization is more comfortable to read in technical documentation.
@@ -132,15 +131,15 @@ For titles use "Sentence case capitalization". Sentence case capitalization is m
132
131
Use United States English. For example, behavior rather than behaviour, and canceled rather than cancelled.
133
132
134
133
[[proper-names]]
135
-
=== Proper names
134
+
=== Proper names
136
135
anchor:propernames[historical anchor]
137
136
138
137
When referring to the name of a development language we use the proper name or, where appropriate, the industry convention. For example, HTML, CSS, JavaScript, jQuery, React, AngularJS (not HTML, css, Jquery or React-js.)
139
138
140
139
The exception to this rule is when we are talking about the code itself (see the note above about TinyMCE v. tinymce). For example, write "HTML is great" when talking about the HTML language, but write, "escape your ``html``" when talking about action with or within a codebase.
Write in a https://www.grammarly.com/blog/first-second-and-third-person/[third person perspective], such as: _He_, _she_, _they_, or _them_.
163
162
164
163
[[keep-it-simple]]
165
-
=== Keep it simple
164
+
=== Keep it simple
166
165
anchor:keepitsimple[historical anchor]
167
166
168
167
Use short, simple words where possible. Use formal language, do not use: slang, acronyms, initialisms, abbreviations, and https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions[ambiguous contractions (such as _there'd_, or _it'll_)].
If you would like to contribute to the TinyMCE project please read the TinyMCE Documentation Contributor's Guide at either:
@@ -23,21 +22,21 @@ If you would like to contribute to the TinyMCE project please read the TinyMCE D
23
22
* https://github.com/tinymce/tinymce-docs-4x/blob/develop/CONTRIBUTING.md#contributing-to-the-tinymce-developer-documentation[GitHub - Contributing to the TinyMCE developer 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.
34
33
35
34
[[installing-prerequisites]]
36
-
==== Installing Prerequisites
35
+
==== Installing Prerequisites
37
36
anchor:installingprerequisites[historical anchor]
38
37
39
38
[[linux-users]]
40
-
===== Linux users
39
+
===== Linux users
41
40
anchor:linuxusers[historical anchor]
42
41
43
42
You need the following programs installed on your computer:
To create a development version of the documentation, run:
@@ -130,7 +129,7 @@ To view the documentation; in a web browser, navigate to http://localhost:4000/[
130
129
NOTE: The development version of the documentation will update automatically when you save changes locally.
131
130
132
131
[[tinymce-api-documentation]]
133
-
==== TinyMCE API documentation
132
+
==== TinyMCE API documentation
134
133
anchor:tinymceapidocumentation[historical anchor]
135
134
136
135
The TinyMCE API documentation is maintained within the https://github.com/tinymce/tinymce[TinyMCE project repository] and compiled for the documentation site using https://github.com/tinymce/moxiedoc[MoxieDoc].
@@ -142,7 +141,7 @@ The TinyMCE API documentation is maintained within the https://github.com/tinymc
142
141
* The TinyMCE documentation repository set up for development as described in <<installing-prerequisites,Installing Prerequisites>> and <<first-time-set-up,First time set up>>.
0 commit comments