Updated README.md

This commit is contained in:
Marco Cavalli 2024-01-11 18:09:32 +01:00
parent 6e8f0b0bb9
commit 12816c8ffe
1 changed files with 11 additions and 15 deletions

View File

@ -1,26 +1,22 @@
# barebones
# barebones+
_a [barebones](https://github.com/benchmarkstudios/barebones) fork by [Congegni](https://congegni.net)_
A lightweight and skeletal WordPress boilerplate theme for HTML5 and beyond. There's lots of these out there but most themes include lots of bloat and files which you might not necessarily need, so we thought we would create our own which is great as a starting point with powerful features to encourage rapid development for most projects.
We loved barebones, but we needed some adjustments for our projects.
## Features
* Reset, normalisation and base font/form styles
* Scss Boilerplate - semantically named files, organised by folders, all compiled into a single file
* Semantic use of HTML5 elements, includes Google HTML5 shiv
* WAI-ARIA role ready
* jQuery plugin agnostic
* Basic template files
* Customised functions.php adding theme support for high customisation
* Minimised HTTP requests for high Web Performance
* Localised strings for multiple language support
* Scss compiling and watching, css minification support
* Base mobile nav out of the box
* For standard barebones features, check out [here](https://github.com/benchmarkstudios/barebones?tab=readme-ov-file#features). We just removed some functions that we don't need.
* Custom `index.php` as 404 template.
* Deferred YouTube Video custom block.
* Added a `css` class and a standard block support:
* `cover` block basic support (in `/assets/styles/_main.scss`)
* `.fullwidth` for full width elements (in `/assets/styles/_main.scss` and `/assets/scripts/scripts.js`)
## Installation
Clone the barebones repositories into your WordPress /wp-content/themes/ directory:
Clone the barebones+ repositories into your WordPress /wp-content/themes/ directory:
git clone https://github.com/benchmarkstudios/barebones
git clone https://git.congegni.net/Congegni/barebones
cd barebones
### Using Laravel Mix