Meshki is a simple, black-colored, responsive boilerplate to kickstart any responsive project.
It is only ~20 KiB (minified) and ~30 KiB (normal), including both Scss/CSS and JS files.
Check out https://borderliner.github.io/Meshki/ for samples and details.
- Getting Started (for users)
- Build (for developers and contributors)
- Why Meshki is Awesome
- Browser Support
- Known Issues and Roadmap
- Tools Used
Getting Started (for users)
There are a couple ways to get Meshki (choose only one):
Use CDN: Link Meshki directly into your project with
<script>tags. Meshki is hosted on two famous content delivery networks:
Clone the repo: Open a console and issue (without $):
$ git clone https://github.com/Borderliner/Meshki.git
Note: Meshki is always under active development, so if you're looking for a stable and safe release, use the compressed packages. Cloning the repo is needed only if you want to contribute to the project.
bower install meshki(Not Recommended)
npm install meshki(Not Recommended)
Clone the repo:
git clone https://github.com/Borderliner/Meshki.git && cd Meshki
Install all the dependencies (don't use both):
To compile Meshki, the file
build.js contains the scripts you need to compile Meshki. There are a couple of commands you can use via
yarn so that you don't have to use
npm run compile
yarn run compile
To compile and watch for file changes:
npm run watch
yarn run watch
Sometimes when you upgrade your NodeJS,
node-sass needs to be recompiled for the newer version. To do so, run the following command:
npm run rebuild-sass
yarn run rebuild-sass
# Why Meshki is Awesome
Meshki is lightweight, stylish and minimal. It styles only raw HTML elements (with a few exceptions) and provides a responsive grid with a fresh-looking interface.
- Dependency-free! You don't need
- No compilation or any specific installation needed. Just link 2 files of
- Although Meshki is not a UI framework, it's a CSS library, you can create most of the interface with just using Meshki
- Around 1.3k lines of unminified CSS, with comments
- Can be installed via different tools:
- Hosted on the most famous CDNs: CloudFlare and jsDelivr
- Clean code, smooth interface, easy yet professional
- Linter configurations, comments, all available for contributors
Latest version of these browsers are implied:
- Chrome, Chromium, Opera, Microsoft Edge -> ✓ Well-Tested
- Mozilla Firefox -> ✓ Well-Tested
- Safari -> No issues reported.
- Internet Explorer 9+ -> No animations on IE 9. Do not open issues regarding IE 8 and below Change Your Browser, Please!
The above list is non-exhaustive. Meshki works fine with almost all older versions of the above browsers, though IE certainly has large degradation prior to IE 9, and you are advised to always keep your browser up-to-date.
Known Issues and Roadmap
Not any production-obstructing issues are currently present. For all known issues and project roadmap, see CHANGELOG.
Meshki has been developed mainly on PC, using VSCode and its surrounding tools.
All parts of Meshki are free to use under the permissive Apache-2.0 License.
All other non-Meshki codes have their own respective licenses. Check out their repositories for more information. The website of Meshki uses:
Meshki was originally started by Mohammadreza Hajianpour as a fork of Skeleton. Meshki has come a long way since then and has experienced a total overhaul, including porting the codebase from CSS to Scss. Skeleton was created by Dave Gamache.
Thanks to all contributors and supporters of Meshki, you are AWESOME.