Skip to content

Commit 0b06026

Browse files
committed
Fixing codeblocks and notes?
1 parent 8957c6d commit 0b06026

File tree

230 files changed

+2331
-1604
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

230 files changed

+2331
-1604
lines changed

CONTRIBUTING.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,40 +40,40 @@ Include any key values pairs and method options that are required to enable a us
4040

4141
For example, this is good:
4242

43-
`
43+
----
4444
tinymce.init({
4545
selector: 'textarea', // change this value according to your HTML
4646
plugins: 'codesample',
4747
toolbar: 'codesample'
4848
});
49-
`
49+
----
5050

5151
This is not:
5252

53-
`+
53+
----
5454
tinymce.init({
5555
...
5656
plugins: 'codesample',
5757
toolbar: 'codesample'
5858
...
5959
});
60-
+`
60+
----
6161

6262
=== URLs and links
6363

6464
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:
6565

66-
`+
66+
----
6767
hello, [text to link](http://www.example.com) to the URL example.com.
68-
+`
68+
----
6969

7070
=== Codepens
7171

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

74-
`
74+
----
7575
{% include codepen.html id="basic-example" %}
76-
`
76+
----
7777

7878
There are several options for this include file - please see `_includes/codepen.html` for details.
7979

@@ -83,7 +83,7 @@ The source for each CodePen is store in the `_includes/codepens/` directory.
8383

8484
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.
8585

86-
`
86+
----
8787
--- // Three dashes at the start and end of the meta section, must be included.
8888
layout: default // In most cases leave this as 'default'.
8989
title: // The nav.yml references this so it must be included and it should be brief.
@@ -92,7 +92,7 @@ description_short: // Short description for the grid layouts.
9292
description: // Detailed description at page level for the header section under the title.
9393
keywords: // Space-separated list of keywords in the content.
9494
---
95-
`
95+
----
9696

9797
== Style Guide
9898

README.adoc

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -33,29 +33,29 @@ The following procedure assists with building (or compiling) the documentation l
3333
You need the following programs installed on your computer:
3434

3535
* Ruby version 2 or later. To verify the installed version, run:
36-
`
36+
----
3737
ruby --version
38-
`
38+
----
3939

4040
. Install git, g{pp}, `make`, and the zlib development files. For example:
4141
** On Fedora, run:
4242
+
43-
`pass:c[
43+
----
4444
sudo dnf install git-all gcc-c++ make zlib-devel
45-
]`
45+
----
4646

4747
** On Ubuntu, Debian or their derivatives, run:
48-
`
48+
----
4949
sudo apt install git gcc cpp make zlib1g-dev
50-
`
50+
----
5151
. Install Ruby Nokogiri: \https://nokogiri.org/
5252
`
5353
sudo gem install nokogiri
54-
`
54+
----
5555
. Install Ruby Bundler. Install using:
5656
`
5757
sudo gem install bundler
58-
`
58+
----
5959
. (optional) Docker
6060

6161
===== Windows users
@@ -67,18 +67,18 @@ If you are a Windows user, follow these steps to work on TinyMCE documentation:
6767
. Run the following command on a command prompt to install Ruby Bundler:
6868
`
6969
gem install bundler
70-
`
70+
----
7171
7272
===== Mac OS users
7373
7474
. Ruby version 2 or later is required. Verify the pre-installed version, using:
7575
`
7676
ruby --version
77-
`
77+
----
7878
. Install Ruby Bundler, using:
7979
`
8080
gem install bundler
81-
`
81+
----
8282
8383
==== First time set up
8484
@@ -87,23 +87,23 @@ Once you have installed any missing prerequisites, in a terminal or on a command
8787
. Clone the git repository:
8888
`
8989
git clone [email protected]:tinymce/tinymce-docs.git
90-
`
90+
----
9191
. Change directory into the cloned git repository:
9292
`
9393
cd tinymce-docs
94-
`
94+
----
9595
. Run the initialization script to install dependencies and create the required local files in the git repository:
9696
`
9797
./_scripts/init.sh
98-
`
98+
----
9999

100100
==== Run the development version of the documentation
101101

102102
To create a development version of the documentation, run:
103103

104-
`
104+
----
105105
./_scripts/serve.sh
106-
`
106+
----
107107

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

@@ -124,34 +124,34 @@ The TinyMCE API documentation is maintained within the https://github.com/tinymc
124124

125125
To install MoxieDoc, run:
126126

127-
`
127+
----
128128
npm install -g git://github.com/tinymce/moxiedoc.git
129-
`
129+
----
130130

131131
===== Run the development version of the documentation for the current TinyMCE version
132132

133133
. Download the TinyMCE version in the `.api-version` file in this project's root directory and extract the API documentation using:
134-
`
134+
----
135135
./_scripts/api-reference.sh
136-
`
136+
----
137137
. Start the development server using:
138-
`
138+
----
139139
./_scripts/serve.sh
140-
`
140+
----
141141

142142
===== Run the development version of the documentation for a local TinyMCE repository
143143

144144
. Extract the API documentation from a local copy of the TinyMCE repository using:
145-
`
145+
----
146146
./_scripts/api-reference-local.sh <path/to/the/tinymce/repo>
147-
`
147+
----
148148
. Start the development server using:
149-
`
149+
----
150150
./_scripts/serve.sh
151-
`
151+
----
152152
. To include updates made to the TinyMCE API documentation in the TinyMCE repository, run the `api-reference-local` script:
153-
`
153+
----
154154
./_scripts/api-reference-local.sh <path/to/the/tinymce/repo>
155-
`
155+
----
156156

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

_includes/configuration/allow-conditional-comments.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ This option allows you to specify whether the editor should parse and keep condi
1010

1111
===== Example
1212

13-
`js
13+
[source,js]
14+
----
1415
tinymce.init({
1516
selector: 'textarea', // change this value according to your HTML
1617
allow_conditional_comments: true
1718
});
18-
`
19+
----

_includes/configuration/allow-html-in-named-anchor.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ This option allows you to specify whether the editor should parse and keep `html
1010

1111
===== Example
1212

13-
`js
13+
[source,js]
14+
----
1415
tinymce.init({
1516
selector: 'textarea', // change this value according to your HTML
1617
allow_html_in_named_anchor: true
1718
});
18-
`
19+
----

_includes/configuration/allow-script-urls.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ Enabling this option will allow `javascript: urls` in links and images. This is
1010

1111
===== Example
1212

13-
`js
13+
[source,js]
14+
----
1415
tinymce.init({
1516
selector: 'textarea', // change this value according to your HTML
1617
allow_script_urls: true
1718
});
18-
`
19+
----

_includes/configuration/allow-unsafe-link-target.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ By default all links with a `target` of __blank_ will get a `rel` attribute of `
1010
1111
===== Example
1212
13-
`js
13+
[source,js]
14+
----
1415
tinymce.init({
1516
selector: 'textarea',
1617
allow_unsafe_link_target: true
1718
});
18-
`
19+
----

_includes/configuration/anchor-bottom.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,20 @@ Lets you specify a custom name for the bottom anchor in the url type ahead drop
88

99
===== Example of custom value
1010

11-
`js
11+
[source,js]
12+
----
1213
tinymce.init({
1314
selector: 'textarea',
1415
anchor_bottom: '#mybottom'
1516
});
16-
`
17+
----
1718

1819
===== Example of disabling
1920

20-
`js
21+
[source,js]
22+
----
2123
tinymce.init({
2224
selector: 'textarea',
2325
anchor_bottom: false
2426
});
25-
`
27+
----

_includes/configuration/anchor-top.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,20 @@ Lets you specify a custom name for the top anchor in the url type ahead drop dow
88

99
===== Example of custom value
1010

11-
`js
11+
[source,js]
12+
----
1213
tinymce.init({
1314
selector: 'textarea',
1415
anchor_top: '#mytop'
1516
});
16-
`
17+
----
1718

1819
===== Example of disabling
1920

20-
`js
21+
[source,js]
22+
----
2123
tinymce.init({
2224
selector: 'textarea',
2325
anchor_top: false
2426
});
25-
`
27+
----

_includes/configuration/auto-focus.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ Automatically set the focus to an editor instance. The value of this option shou
66

77
===== Example
88

9-
`js
9+
[source,js]
10+
----
1011
tinymce.init({
1112
selector: 'textarea', // change this value according to your HTML
1213
auto_focus: 'element1'
1314
});
14-
`
15+
----

_includes/configuration/automatic-uploads.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,11 @@ WARNING: Note that, this option will do nothing if `images_upload_url` is not sp
1212

1313
===== Example
1414

15-
`js
15+
[source,js]
16+
----
1617
tinymce.init({
1718
selector: 'textarea', // change this value according to your HTML
1819
images_upload_url: 'postAcceptor.php',
1920
automatic_uploads: false
2021
});
21-
`
22+
----

0 commit comments

Comments
 (0)