A starter kit for building static sites quickly, easily, and efficiently.
View live demo →
- Super simple to use and develop with. No messing with settings and configurations.
- Easy to use for those who are not familiar with Hugo. They shouldn't have to learn more than the basics.
- Powered by tools that are focused on a quick and efficient development cycle.
- Pre-packed with shortcodes & partials for a ton of different components.
🚧 Hugo - The fastest framework for building static sites
🎨 TailwindCSS, Tailwind Forms, and Tailwind Typography Utility-first CSS framework to build your site without ever having to leave your HTML.
🔧️ PostCSS, autoprefixer, and PurgeCSS Trim your CSS files (including Tailwind's) to be only the classes and rules you actually use in your markup.
🌈️ Prettier and stylelint Write better code without having to think about formatting.
🔍️ ESLint Never run into JS errors again.
Getting set up for using this project requires install a few different things. Don't worry, it's easy.
You will need to install Hugo if you don't already have it. There are pre-built binary files available for almost every platform.
Once you have Yarn and Hugo installed on your system, all you need to do is grab a copy of Pears and install the dependencies.
git clone https://github.com/bradp/pears <your-new-site-name>
cd <your-new-site-name>
npm i
- To start up your local development environment:
npm start - To see a full list of available commands:
npm run
| Command | Action |
|---|---|
npm start |
Builds all files & starts up the development server |
npm build |
Builds all files for a local or staging environment |
npm build:prod |
Builds all files for a deployment to a production server |
npm lint |
Check your CSS & JS files for errors Append :fix to automatically fix |
npm format |
Fix formatting errors automatically |
| Command | Action |
|---|---|
npm lint:css |
Lint CSS files Append :fix to automatically fix |
npm lint:js |
Lint JS files. Append :fix to automatically fix |
npm format:check |
Check formatting errors without automatically fixing |
Remember, you can always check yarn run to see full list of commands!
See the open issues for a list of proposed features (and known issues).
Distributed under the MIT License. See LICENSE for more information.