From 15eb26af444cd3090e54e5ee345c20bc7fc04123 Mon Sep 17 00:00:00 2001 From: Przemyslaw Zan Date: Tue, 2 Nov 2021 12:51:01 +0100 Subject: [PATCH 1/2] Added metadata file, moved links below the codeblock, shortened some descriptions to fit width of the codeblock. --- docs/framework/guides/package-generator.md | 45 +++++++++++++--------- 1 file changed, 26 insertions(+), 19 deletions(-) diff --git a/docs/framework/guides/package-generator.md b/docs/framework/guides/package-generator.md index a804f5b6170..0067a788f4c 100644 --- a/docs/framework/guides/package-generator.md +++ b/docs/framework/guides/package-generator.md @@ -51,33 +51,40 @@ An overview of the project's directory structure: ```plain-text ├─ sample -│ ├─ dll.html # The editor initialized using the DLL builds. -│ ├─ index.html # The sample file. -│ └─ ckeditor.js # The editor initialization script. +│ ├─ dll.html # The editor initialized using the DLL builds. +│ ├─ index.html # The sample file. +│ └─ ckeditor.js # The editor initialization script. ├─ src -│ ├─ index.js # The modules exported by the package when using the DLL builds. -│ ├─ myplugin.js # The plugin that shows the very basic usage of the CKEditor 5 framework. -│ └─ **/*.js # All JavaScript source files should be saved here. +│ ├─ index.js # The modules exported by the package when using the DLL builds. +│ ├─ myplugin.js # Very basic plugin that utilizes the CKEditor 5 framework. +│ └─ **/*.js # All JavaScript source files should be saved here. ├─ tests -│ ├─ index.js # Tests for the plugin. +│ ├─ index.js # Tests for the plugin. │ ├─ myplugin.js -│ └─ **/*.js # All tests should be saved here. +│ └─ **/*.js # All tests should be saved here. ├─ theme │ ├─ icons -│ │ ├─ ckeditor.svg # The CKEditor 5 icon displayed in the toolbar. -│ │ └─ **/*.svg # All icon files should be saved here. -│ └─ **/*.css # All CSS files should be saved here. +│ │ ├─ ckeditor.svg # The CKEditor 5 icon displayed in the toolbar. +│ │ └─ **/*.svg # All icon files should be saved here. +│ └─ **/*.css # All CSS files should be saved here. │ -├─ .editorconfig # See https://editorconfig.org/ for details. -├─ .eslintrc.js # ESLint configuration file. -├─ .gitattributes # See https://git-scm.com/docs/gitattributes for details. -├─ .gitignore # See https://git-scm.com/docs/gitignore for details. -├─ .stylelintrc # Stylelint configuration file. -├─ LICENSE.md # All packages created with the tool are available under the MIT license. -├─ package.json # See https://docs.npmjs.com/cli/v7/configuring-npm/package-json for details. -└─ README.md # Description of your project and usage instructions. +├─ .editorconfig # See link below for details. +├─ .eslintrc.js # ESLint configuration file. +├─ .gitattributes # See link below for details. +├─ .gitignore # See link below for details. +├─ .stylelintrc # Stylelint configuration file. +├─ ckeditor5-metadata.json # See link below for details. +├─ LICENSE.md # All created packages fall under the MIT license. +├─ package.json # See link below for details. +└─ README.md # Description of your project and usage instructions. ``` +Guides for developing some files: +* [.editorconfig](https://editorconfig.org/) +* [.gitattributes](https://git-scm.com/docs/gitattributes) +* [.gitignore](https://git-scm.com/docs/gitignore) +* {@link framework/guides/contributing/package-metadata ckeditor5-metadata.json} +* [package.json](https://docs.npmjs.com/cli/v7/configuring-npm/package-json) ## Npm scripts Npm scripts are a convenient way to provide commands in a project. They are defined in the `package.json` file and shared with other people contributing to the project. It ensures that developers use the same command with the same options (flags). From d792bb0a324edd4cb358fd0a92e993dd0fb04f10 Mon Sep 17 00:00:00 2001 From: Przemyslaw Zan Date: Tue, 2 Nov 2021 12:55:24 +0100 Subject: [PATCH 2/2] Added missing empty line --- docs/framework/guides/package-generator.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/framework/guides/package-generator.md b/docs/framework/guides/package-generator.md index 0067a788f4c..6af39cb50bc 100644 --- a/docs/framework/guides/package-generator.md +++ b/docs/framework/guides/package-generator.md @@ -85,6 +85,7 @@ Guides for developing some files: * [.gitignore](https://git-scm.com/docs/gitignore) * {@link framework/guides/contributing/package-metadata ckeditor5-metadata.json} * [package.json](https://docs.npmjs.com/cli/v7/configuring-npm/package-json) + ## Npm scripts Npm scripts are a convenient way to provide commands in a project. They are defined in the `package.json` file and shared with other people contributing to the project. It ensures that developers use the same command with the same options (flags).