Barebones HTML project is a set of defaults for a headstart in HTML project development. It provides developers with common tools to make HTML markup creation faster and easier.
Unlike most other project templates, Barebones is highly preferential: it makes a lot of choices for the user right from the beginning:
- It includes a default build system -- Gulp -- with a set
of default build instructions in
gulpfile.js - It uses Bower to download third-party libraries for your project
- It includes infrastructure for Compass -- a SASS framework
- It includes a complete scss stylesheet with a lot of predefined elements
- It includes preferences for Sublime Text -- an awesome text editor for code and markup
You can, of course, use a different builder, a different (or none at all) CSS preprocessor or a different editor. But a very specific default choice allows you to start working sooner. No need to setup build instructions, no need to download vendor libraries, no need to create a style structure. Unless you want to change the defaults, that is :)
Barebones is built for development in Sublime Text. That is why Barebones
provides a default .sublime-project file. This file provides the editor with
a list of files and folders to ignore, a default set of formatting settings
for the project, and a build system configuration for Gulp.
Barebones also contains an .editorconfig file, which is the preferred way of defining formatting options for the project. To use it, you must install an editorconfig plugin
- Copy all files from Barebones repository to project directory.
- Install node dependencies with npm by running:
npm install
- Rename
Barebones.sublime-projectto match your project name - Edit
package.jsonto match your project information - Optionally, edit source and destination build paths in
barebones.json
Barebones contains some default build instructions, including a custom server task. Before you can start working, you need to download and set up all vendor dependencies:
gulp init
After that you can just run the server task, and it will rebuild your resources every time you save changes in the source files:
gulp server
Note: shortly after running the server task, gulp will report that the task is finished. The server itself will continue to run. To stop the server task, press Ctrl+C (or Cmd+C) in the console.
You can also initiate rebuild from within Sublime Text by pressing Ctrl+B (or Cmd+B). To use this shortcut, you must select "Barebones Gulp" in Sublime's "Tools" > "Build System" menu.
Copyright (c) 2014 Anton Suprun Licensed under the MIT license
This software uses parts of HTML5 Boilerplate licensed under the MIT license and its source can be downloaded here.