https://github.com/benjaminreid/hermit

Hermit is a simple and lightweight starting point for single page static websites.
https://github.com/benjaminreid/hermit

browsersync cssnano html postcss tailwindcss template

Last synced: 2 days ago
JSON representation

Hermit is a simple and lightweight starting point for single page static websites.

• Host: GitHub
• URL: https://github.com/benjaminreid/hermit
• Owner: benjaminreid
• License: mit
• Created: 2020-10-13T17:14:24.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-09-16T12:12:16.000Z (over 3 years ago)
• Last Synced: 2024-04-15T22:33:31.768Z (9 months ago)
• Topics: browsersync, cssnano, html, postcss, tailwindcss, template
• Language: JavaScript
• Homepage:
• Size: 269 KB
• Stars: 9
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# :crab: Hermit

Hermit is a small back-to-basics starting point for single page static websites.

It provides a fast and painless developer experience with live reloading from [Browsersync](https://browsersync.io/) and utility-first CSS support from [Tailwind](https://tailwindcss.com/) so you can iterate quickly and ship as little code as possible to your visitors.

_No build tools or packagers_ (sort of). There are two small easy to read scripts (one for [development](scripts/start.js) and one for [building](scripts/build.js)) that you can completely ignore but adapt if want to.

[PostCSS](https://postcss.org/) handles the processing of the CSS so you can easily extend it as you might need and [cssnano](https://cssnano.co/) is there for you when you build your site.

HTML is ~genereated with~ just plain ol’ HTML.

## Installation

The only dependencies you’ll need to install are for working with and building your site. No library or frameworks are shipped to production.

```

yarn install

```

## Getting started

A [Browsersync](https://browsersync.io/) server is provided out of the box so you can get coding in the browser quickly.

```

yarn run start

```

## Building

Once you’re all done, it’s time to build your site. The proivded `build` command minifies your HTML, purges unused CSS, compresses it with [cssnano](https://cssnano.co/) and the CSS file name is automatically cache busted.

After you’ve built your site, take the `dist` folder and upload it to your host of choice.

```

yarn run build

```

If you want to preview your site, you can run

```

npx http-server ./dist

```

## Don’t forget

- Generate your own favicons, [favicon.io](https://favicon.io/) is a great place to do this.