https://github.com/5t3ph/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.
https://github.com/5t3ph/html-sass-jumpstart

autoprefixer browsersync css html node-sass sass sass-boilerplate stylelint

Last synced: 29 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/5t3ph/html-sass-jumpstart
• Owner: 5t3ph
• Created: 2019-09-29T20:11:59.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-01-06T02:10:59.000Z (almost 2 years ago)
• Last Synced: 2024-10-02T03:23:14.044Z (about 1 month ago)
• Topics: autoprefixer, browsersync, css, html, node-sass, sass, sass-boilerplate, stylelint
• Language: HTML
• Homepage: https://5t3ph.github.io/html-sass-jumpstart/
• Size: 605 KB
• Stars: 89
• Watchers: 5
• Forks: 11
• Open Issues: 21
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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 >**](https://5t3ph.github.io/html-sass-jumpstart/) 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](https://stylelint.io/) and rules are extended from [stylelint-config-standard](https://github.com/stylelint/stylelint-config-standard) and [prettier-stylelint](https://github.com/hugomrdias/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](https://github.com/5t3ph/html-sass-jumpstart/issues).

[![Buy me a coffee](https://cdn.buymeacoffee.com/buttons/default-violet.png)](https://www.buymeacoffee.com/moderncss)