spc_article

- Designed to display current article

- Designed as a Spacecraft Starterkit compatible component

Here is a styleguide for this component and the rest in it's theme

About

Ths Spc_article component will contain and display the article whom is currently chosen. The heading will adjust to fullwidth and you can linebreak it with the <br />-tag. Css styles set as parameters are "theme color" and the max-width of the content which you can easily customise and there is prepared styles for the most common html-elements with ongoing updates for better support. The "main image" are best fit for landscape format.

Install

Spacecraft Starterkit

If you have not yet installed Spacecraft Starterkit , do so by running:

git clone [e-mail]:pedric/spacecraft-starterkit.git

cd spacecraft-starterkit

npm install

spc_article

If you have already installed Spacecraft Starterkit, run:

npm install --save spc_article && gulp import --component spc_article

And don't forget to import the css by adding:

@import "views/spc_article/spc_article";

in

./src/scss/components/_components.main.scss

PROJECT COMPONENTS AT GITHUB

Root

Export the path with module.exports = __dirname; in your index.js file so that the import tasks in Spacecraft can reach your files.

Care about your friends by setting up changelog-, license- and readme files for your component.

Folders

Docs

Add a markdown for your component that will be visible in the documentation for the styleuide. Here is an example.

Icons

SVG icons goes here. Components that not uses any icons can skip this folder.

Img

Images goes here. Probably there will be some placeholder images here, provide guidelines and info in the documentation. Components that not uses any images can skip this folder.

js

Here you'll put Javascript for the component, in Spacecraft you can (and are suggested to) isolate your JS to the component by making a module as described here.

View

This is the place for:

• HTML (Twig)

• CSS (SCSS)

• Config (JSON)

Twig is Spacecraft´s default but Nunjucks, Handlebars etc can be used. This is set in Spacecraft´s config for your project.