turretcss - A Responsive Front-end Framework for Accessible and Semantic Websites with default HTML elements, created by Scott de Jonge.
To get started, check out !
Table of contents
Quick start
Several quick start options are available:- Download the latest release.
- Clone the repo:
git clone https://github.com/turretcss/turretcss.git. - Install with npm:
npm install turretcss. - Install with yarn:
yarn add turretcss
Read the Getting started page for information on structure, usage, support and more.
Bugs and feature requests
Have a bug or a feature request? Please first search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.Documentation
View full documentation at:turretcss's documentation, included in this repo in the
docs directory, is built with Jekyll and publicly hosted on GitHub Pages at . The docs may also be run locally.Tooling
To use and run the documentation locally, you'll need a copy of turretcss's source files, and Node. To install the required tools follow these steps:- Download and install Node, which we use to manage our dependencies.
- Navigate to the root
/turretdirectory and runnpm installto install our local dependencies listed in package.json. - Install Rubyinstall-ruby, install Bundlergembundler with
gem install bundler, and finally runbundle install. This will install all Ruby dependencies, such as Jekyll and plugins.
- Windows users: Read this unofficial guide to get Jekyll up and running without problems.
When completed, you'll be able to run the various scripts provided from the command line.
Scripts
turretcss includes the following commands and tasks:| Task | Description | | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | |
start | Run npm run watch |
| watch | Run npm run watch:turret & npm run watch:docs |
| watch:turret | Watches changes to the /turret directory and builds turret CSS npm run compile:turret -- --verbose --watch |
| watch:docs | Watches changes to the /docs directory and builds docs CSS npm run compile:docs -- --verbose --watch |
| compile:turret | Builds turret CSS using PostCSSpostcss, postcss-preset-envpostcss-preset-env, and CSSNanocssnano with config in postcss.config.js |
| compile:docs | Builds docs CSS using PostCSSpostcss, postcss-preset-envpostcss-preset-env, and CSSNanocssnano with config in postcss.config.js |
| format | Run npm run format:css & npm run format:md |
| format:css | Prettier CSS files prettier --single-quote --print-width 180 --write '*.css' |
| format:md | Prettier Markdown files prettier --print-width 180 --write '*.md' |Autoprefixer
turretcss uses Autoprefixerautoprefixer as part of postcss-preset-env to automatically add vendor prefixes to some CSS properties at build time.Running documentation locally
- Install Install Rubyinstall-ruby, install Bundlergembundler with
gem install bundler. - Install Jekyll (the site builder) and other Ruby dependencies with
bundle install. This will install all Ruby dependencies, such as Jekyll and plugins. - Run
npm startoryarn startto rebuild CSS. - From the
/docsdirectory, runbundle exec jekyll servein the command line. - Open in your browser.
Learn more about using Jekyll by reading its documentation.
Troubleshooting
Should you encounter problems with installing dependencies or running scripts, uninstall all previous dependency versions (global and local). Then, rerunnpm install.Updates
Keep track development updates by following @turretcss on Twitter.Versioning
For transparency into our release cycle and in striving to maintain backward compatibility, turretcss is maintained under the Semantic Versioning guidelines.See the Releases section of our GitHub project for changelogs for each release version of turretcss.
Creators
Scott de Jonge- Twitter: @scottdejonge
- Github: @scottdejonge
