- Square blocks for articlepreviews
- Designed as a Spacecraft Starterkit compatible component
Here is a styleguide for this component and the rest in it's theme
About
The article excerpts shows the image, heading, author and tags for each article in a responsive grid.
Install
Spacecraft Starterkit
If you have not yet installed Spacecraft Starterkit , do so by running:
git clone git@github.com:pedric/spacecraft-starterkit.git
cd spacecraft-starterkit
npm install
spc_article
If you have already installed Spacecraft Starterkit, run:
npm install --save spc_article_excerpts && gulp import --component spc_article_excerpts
And don't forget to import the css by adding:
@import "views/spc_article_excerpts/spc_article_excerpts";
in
./src/scss/components/_components.main.scss
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.