File Names - ckeditor/ckeditor5-design GitHub Wiki

⚠⚠ ⚠⚠ ⚠⚠

This wiki served in the early days of CKEditor 5 development and can be severely outdated.

Refer to the official CKEditor 5 documentation for up-to-date information.




File and directory names must follow a standard that make their syntax easy to predict:

  • All lower-cased.
  • Only alphanumeric characters are accepted.
  • Words are separated by dashes (-) (kebab-case).
    • Code entities are considered single words, so the DataProcessor class is defined in the dataprocessor.js file.
  • HTML files have the .html extension.

Examples

  • ckeditor.js
  • tools.js
  • editor.js
  • dataprocessor.js
  • build-all.js and build-min.js
  • test-core-style-system.html

Standard Files

Widely used standard files do not obey the above rules:

  • README.md, LICENSE.md, CONTRIBUTING.md, CHANGES.md
  • .gitignore and all standard "dot-files".
  • gruntfile.js
  • node_modules
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️