sprucecss-site-eleventy
The documentation of Spruce CSS.
Stars
3
Spruce CSS uses 11ty for its documentation (v2).
Get Up and Running
We use eleventy --serve and compile Sass with sass-cli with npm scripts.
-
Clone the repository
-
Install the dependencies
In the
package.jsonfile, you will find all of the dependencies (and scripts) to install them using the following command:npm install -
Run the development mode
To run the development mode, use the
npm run start. This script will also watch for changes.npm run start -
Run the production mode
Before you go live, you should use the production script to compress the Sass files.
npm run build
SCSS
The project compiles the SCSS files from the ./src/scss folder into the ./src/css folder. The project includes Spruce CSS, which gives the styling with some Spruce UI components.
Other Scripts
-
sass:lint/sass:lint:fix You can lint your SCSS files with Stylelint and stylelint-config-sass-guidelines preset with the
npm run sass:lintcommand. Use thenpm run sass:lint:fixcommand if you want automatic fixes.
Badges
Extracted from project README