Skip to content
Boilerplate project for creating Content Station Digital Editor components.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
components
docs
scripts
.gitignore
README.md
_config.yml
gulpfile.js
package-lock.json
package.json

README.md

csde-components-boilerplate

Boilerplate project for creating Content Station Digital Editor component sets.

Creating component sets

This section describes how to set up, develop and package component sets out of the boilerplate.

Important: use a release of the boilerplate that is supported by the target Content Station. See the Releases page for an overview.

Download, clone or fork this repository from the desired release tag.

Setup

Make sure to have installed NodeJS 8 or higher.

Next, run in the folder where this README is located:

npm install

Develop

Follow the instructions listed in the Setup section and then, in the new folder, run:

npm run dev

This will watch for any changes in the components folder and run the validation logic.

Please see the Documentation Components Model for more details on the expected structure of a component set.

Package

To create a component set ready for usage, run:

npm run build

This will validate the set and create a zip in the dist folder, which you can upload through the Content Station Management Console.

Getting started guide

This quick guide shows the steps to create a new custom component based on the body component

  1. Copy components/styles/_body.scss to components/styles/_my_component.scss
    • Edit the scss and change .body to .my_component
  2. Edit _my_component.scss to make changes to the default style of your component
  3. Copy components/templates/html/body.html to components/templates/html/my_component.html
    • Edit the html and change the class name body to my_component
  4. Edit components/components-definition.json to define the new component
    • Copy & Paste the body component definition into the components section
    • Change the name to my_component
    • Change the label to "my_component".
    • Scroll to the Groups section and add my_component to one of the groups, for example the text group
  5. Run npm run build from the main dir to build your component set
  6. Upload the component set zip file found in the dist folder using the Component sets page in the the Content Station Management Console. The Console can be found in the Integrations section of the Enterprise admin pages
  7. Create a new Digital Article template in Content Station and select your component set in the create dialog
  8. Create a new Digital Article from the template
  9. Add your component using the + button
You can’t perform that action at this time.