Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: Extend Readme #3

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,35 @@
# Networkteam.Neos.PencilCase

## Installation

1. Install the package into the root-folder of your Project with `composer require networkteam/neos-pencilcase`
1. Then you create the Settings.PencilCase.yaml in the Configurations Folder of the DistributionPackages.
1. At last you add the package as a dependency to the composer.json of the DistributionPackages as well:
```json
{
"require": {
"networkteam/neos-pencilcase": "*",
}
}
```

## Usage

Now it is possible to define custom Options in the Settings.PencilCase.yaml. The options can be addressed in the NodeType-Definitions. Under editorOptions/formatting it is possible to name and activate the custom options.

#### NodeType.yaml

```yaml
ui:
inline:
editorOptions:
formatting:
violet: true
fancy: true
```

## Example Settings.PencilCase.yaml

Customize your CKeditor using a yaml file

```yaml
Expand Down