Basis comes with a bare minimum of pre-installs, ready for you to take it to the next level.
It is literally, the Basis for building a good, performant website.
The Basis for building a good, performant website. Middleman Basis uses:
- Search Engine Sitemap
Install middleman-basis as Middleman template.
git clone https://github.com/pzi/middleman-basis.git ~/.middleman/middleman-basis
Initialize a new Middleman project with the middleman-basis template
middleman init MY_PROJECT_FOLDER --template=middleman-basis cd project_name
In case you are using Middleman v4.x:
middleman init MY_PROJECT_FOLDER -T pzi/middleman-basis
Install Bower packages:
Install required gems:
Make it your own!
After you have successfully set up the template for your new project, it's time to make it your own. You have the entire Middleman Basis repository as part of your new project, which includes a lot of files you won't need (e.g.
.travis.yml, this version of the README etc.). So please, go ahead and remove files and/or change the content of them, according to your project's needs.
Middleman Basis makes use of Data Files. By default, the template comes with 2 data files:
It's important that these 2 files get updated accordingly! It'd be unfortunate if your project gets launched with "Example" content. If you follow the examples, it will speed up the entire spin up procedure.
By default, middleman-basis only uses
middleman-smusher to compress images. If you take image compression and optimisation serious, you will want to use
To make use of
middleman-imageoptim, you will have to set up external utilities.
Once you have those tools, you can enable (uncomment it) in
- GitHub page
- More/better documentation
- Better spin-up instruction/how to use it as a template
- Fork it
bower install && bundle install
- Create your feature branch (
git checkout -b feature/my-new-feature)
- Commit your changes (
git commit -am 'Added some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request