andrewriveradev / html-sass-jumpstart

Minimal Sass/HTML Template Site - dart sass powered, includes stylelint and prettier, and autoprefix upon build. develop script includes hot-reload via browsersync.

HTML / Sass Jumpstart

dart sass powered, includes stylelint and prettier, and autoprefix upon build. develop script includes hot-reload via browsersync.

Includes Minimal Theme and Components

View the documentation > available on Github pages, as well as the index.html file once you load the project.

Getting Started

1. Select "Use this template" to copy this project into your own new repo.

2. Optional: Run a find/replace for tdbc to update to your preferred prefix (or adjust stylelint settings).

3. You can customize the theme Sass directly, or place overrides to variables at the top of the main style.scss file before the theme file is imported.

4. Then continue with the develop script and build something rad :)

Development Scripts

npm start

Serve with hot reload at localhost:1337

npm run build

Generate minified, autoprefixed CSS for production

Use this as the "Publish command" if needed by hosting such as Netlify.

npm run serve

Serve latest build files at localhost:1337

Linting

Linting is provided by Stylelint and rules are extended from stylelint-config-standard and prettier-stylelint

Lint Script

npm run lint

Run stylelint and review errors in terminal

npm run lint:fix

Run stylelint with the fix flag to attempt to resolve found errors

Feedback welcome!

You can file it as an issue.