Bladeren bron

Reviewed the docs even further.

Piotrek Koszuliński 7 jaren geleden
bovenliggende
commit
75c97420d8

+ 2 - 2
docs/builds/guides/development/custom-builds.md

@@ -25,8 +25,8 @@ Some of the reasons for creating custom builds are:
 
 In order to start developing CKEditor 5 you will require:
 
-* [Node.js](https://nodejs.org/en/) >= 6.0.0
-* npm 4.x (**note:** using npm 5 [causes](https://github.com/lerna/lerna/issues/938) some [problems](https://github.com/npm/npm/issues/16991))
+* [Node.js](https://nodejs.org/en/) 6.9.0+
+* npm 4+ (**note:** some npm 5+ versions were known to cause [problems](https://github.com/npm/npm/issues/16991); especially with deduplicating packages; upgrade npm when in doubt)
 * [Git](https://git-scm.com/)
 
 ## Forking an existing build

+ 2 - 2
docs/builds/guides/development/installing-plugins.md

@@ -17,8 +17,8 @@ In this guide you can learn how to add plugins to your editor in the two most co
 
 In order to start developing CKEditor 5 you will require:
 
-* [Node.js](https://nodejs.org/en/) >= 6.0.0
-* npm 4.x (**note:** using npm 5 [causes](https://github.com/lerna/lerna/issues/938) some [problems](https://github.com/npm/npm/issues/16991))
+* [Node.js](https://nodejs.org/en/) 6.9.0+
+* npm 4+ (**note:** some npm 5+ versions were known to cause [problems](https://github.com/npm/npm/issues/16991); especially with deduplicating packages; upgrade npm when in doubt)
 
 ## Adding a plugin to a build
 

File diff suppressed because it is too large
+ 19 - 14
docs/builds/guides/integration/advanced-setup.md


+ 1 - 1
docs/builds/guides/integration/saving-data.md

@@ -17,7 +17,7 @@ This approach is only available in the {@link builds/guides/overview#classic-edi
 
 ```html
 <!DOCTYPE html>
-<html>
+<html lang="en">
 <head>
 	<meta charset="utf-8">
 	<title>CKEditor 5 - Classic editor</title>

+ 5 - 5
docs/builds/guides/quick-start.md

@@ -47,10 +47,10 @@ Call the {@link module:editor-classic/classiceditor~ClassicEditor#create `Classi
 
 ```html
 <!DOCTYPE html>
-<html>
+<html lang="en">
 <head>
 	<meta charset="utf-8">
-	<title>CKEditor 5 - Classic editor</title>
+	<title>CKEditor 5  Classic editor</title>
 	<script src="https://cdn.ckeditor.com/ckeditor5/{@var ckeditor5-version}/classic/ckeditor.js"></script>
 </head>
 <body>
@@ -99,7 +99,7 @@ Call the {@link module:editor-inline/inlineeditor~InlineEditor#create `InlineEdi
 
 ```html
 <!DOCTYPE html>
-<html>
+<html lang="en">
 <head>
 	<meta charset="utf-8">
 	<title>CKEditor 5 - Inline editor</title>
@@ -151,7 +151,7 @@ Call the {@link module:editor-balloon/ballooneditor~BalloonEditor#create `Balloo
 
 ```html
 <!DOCTYPE html>
-<html>
+<html lang="en">
 <head>
 	<meta charset="utf-8">
 	<title>CKEditor 5 – Balloon editor</title>
@@ -206,7 +206,7 @@ Call the {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `
 
 ```html
 <!DOCTYPE html>
-<html>
+<html lang="en">
 <head>
 	<meta charset="utf-8">
 	<title>CKEditor 5 – Document editor</title>

+ 2 - 2
docs/framework/guides/contributing/development-environment.md

@@ -19,8 +19,8 @@ You can find all the official packages listed in [CKEditor 5 development reposit
 
 In order to start developing CKEditor 5 you will require:
 
-* [Node.js](https://nodejs.org/en/) >= 6.0.0
-* npm 4.x (**note:** using npm 5 [causes](https://github.com/lerna/lerna/issues/938) some [problems](https://github.com/npm/npm/issues/16991))
+* [Node.js](https://nodejs.org/en/) 6.9.0+
+* npm 4+ (**note:** some npm 5+ versions were known to cause [problems](https://github.com/npm/npm/issues/16991); especially with deduplicating packages; upgrade npm when in doubt)
 * [Git](https://git-scm.com/)
 
 ## Setting up the CKEditor development environment

+ 15 - 12
docs/framework/guides/quick-start.md

@@ -11,10 +11,10 @@ This guide will show you how to initialize the editor from source and how to cre
 
 The framework is made of several [npm packages](https://npmjs.com). To install it you need:
 
-* [Node.js](https://nodejs.org/en/) >= 6.0.0
-* npm 4.x (**note:** using npm 5+ [is not recommended](https://github.com/npm/npm/issues/16991))
+* [Node.js](https://nodejs.org/en/) 6.9.0+
+* npm 4+ (**note:** some npm 5+ versions were known to cause [problems](https://github.com/npm/npm/issues/16991); especially with deduplicating packages; upgrade npm when in doubt)
 
-Besides Node.js and npm you also need [webpack@4.x](https://webpack.js.org) with a few additional packages to use the framework. They are needed to bundle the source code. Read more about building CKEditor 5 in the {@link builds/guides/integration/advanced-setup CKEditor 5 Builds Advanced setup} guide.
+Besides Node.js and npm you also need [webpack@4](https://webpack.js.org) with a few additional packages to use the framework. They are needed to bundle the source code. Read more about building CKEditor 5 in the {@link builds/guides/integration/advanced-setup CKEditor 5 Builds Advanced setup} guide.
 
 <!-- TODO replace the link above when the Framework will get its own building guide. -->
 
@@ -29,8 +29,8 @@ npm install --save \
 	postcss-loader \
 	raw-loader \
 	style-loader \
-	webpack@^4.15.0 \
-	webpack-cli@^3.0.8
+	webpack@4 \
+	webpack-cli@3
 ```
 
 The minimal webpack configuration needed to enable building CKEditor 5 is:
@@ -165,7 +165,9 @@ You can now run webpack to build the application. To do that, call the `webpack`
 </info-box>
 
 <info-box>
-	Use `--mode production` if you want to build a minified and optimized application. See more at https://webpack.js.org/concepts/mode/.
+	Use `webpack --mode production` if you want to build a minified and optimized application. See more at https://webpack.js.org/concepts/mode/.
+
+	**Note:** Prior to version 1.2.7 `uglifyjs-webpack-plugin` (the default minifier used by webpack) had a bug which caused webpack to crash with the following error: `TypeError: Assignment to constant variable.`. If you experienced this error, make sure that your `node_modules` contains an up to date version of that package (and that webpack uses this version).
 </info-box>
 
 If everything worked correctly, you should see:
@@ -189,17 +191,18 @@ Finally, it is time to create an HTML page:
 
 ```html
 <!DOCTYPE html>
-<html>
+<html lang="en">
 	<head>
 		<meta charset="utf-8">
 		<title>CKEditor 5 Framework – Quick start</title>
 	</head>
+	<body>
+		<div id="editor">
+			<p>Editor content goes here.</p>
+		</div>
 
-	<div id="editor">
-		<p>Editor content goes here.</p>
-	</div>
-
-	<script src="dist/bundle.js"></script>
+		<script src="dist/bundle.js"></script>
+	</body>
 </html>
 ```