Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
avoinea committed Nov 13, 2020
1 parent 597da25 commit ac5849d
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 26 deletions.
23 changes: 5 additions & 18 deletions DEVELOP.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,18 @@

Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)

1. Install `mrs.developer`

$ npm install -g mrs.developer
1. Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`

1. Install `@plone/create-volto-app`

$ npm install -g @plone/create-volto-app
$ npm install -g yo
$ npm install -g @plone/generator-volto
$ npm install -g mrs-developer

1. Create new volto app

$ create-volto-app my-volto-project
$ yo @plone/volto my-volto-project --addon @eeacms/volto-block-style
$ cd my-volto-project

1. Update `package.json` with the following information:

{
"scripts": {
"develop": "missdev --config=jsconfig.json --output=addons"
},

"addons": [
"@eeacms/volto-block-style"
],
}

1. Add the following to `mrs.developer.json`:

{
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A generic framework to style blocks and other components.
To configure it, set `settings.pluggableStylesBlocksWhitelist` as a list of
block types that you want to enable. By default it is enabled for all blocks.

Ideally it should be loaded as the last addon in Volto project configuration.
Ideally it should be **loaded as the last addon** in Volto project configuration.

###

Expand All @@ -23,12 +23,14 @@ Ideally it should be loaded as the last addon in Volto project configuration.
1. Create new volto project if you don't already have one:

```
$ npm install -g @plone/create-volto-app
$ create-volto-app my-volto-project
$ npm install -g yo @plone/generator-volto
$ yo @plone/volto my-volto-project --addon @eeacms/volto-block-style
$ cd my-volto-project
$ yarn add -W @eeacms/volto-block-style
```

1. Update `package.json`:
1. If you already have a volto project, just update `package.json`:

```JSON
"addons": [
Expand Down
12 changes: 8 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,16 @@
"type": "git",
"url": "git@github.com:eea/volto-block-style.git"
},
"devDependencies": {
"release-it": "*"
},
"scripts": {
"release": "release-it",
"bootstrap": "node bootstrap"
"bootstrap": "node bootstrap",
"stylelint": "../../../node_modules/stylelint/bin/stylelint.js --allow-empty-input 'src/**/*.{css,less}'",
"stylelint:overrides": "../../../node_modules/.bin/stylelint --syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides'",
"stylelint:fix": "yarn stylelint --fix && yarn stylelint:overrides --fix",
"prettier": "../../../node_modules/.bin/prettier --single-quote --check 'src/**/*.{js,jsx,json,css,less,md}'",
"prettier:fix": "../../../node_modules/.bin/prettier --single-quote --write 'src/**/*.{js,jsx,json,css,less,md}'",
"lint": "../../../node_modules/eslint/bin/eslint.js --max-warnings=0 'src/**/*.{js,jsx}'",
"lint:fix": "../../../node_modules/eslint/bin/eslint.js --fix 'src/**/*.{js,jsx}'"
},
"dependencies": {
"react-color": "~2.18.1"
Expand Down

0 comments on commit ac5849d

Please sign in to comment.