turretcss(link is external)

turretcss - A Responsive Front-end Framework for Accessible and Semantic Websites with default HTML elements, created by Scott de Jonge(link is external).

To get started, check out https://turretcss.com(link is external)!

Table of contents

• Quick start
• Bugs and feature requests
• Documentation
• Versioning
• Creators
• Copyright and license

Quick start

Several quick start options are available:

• Download the latest release(link is external).
• Clone the repo: git clone https://github.com/turretcss/turretcss.git.
• Install with npm(link is external): npm install turretcss.
• Install with yarn(link is external): yarn add turretcss

Read the Getting started page(link is external) 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(link is external).

Documentation

View full documentation at: https://turretcss.com/(link is external)

turretcss's documentation, included in this repo in the docs directory, is built with Jekyll(link is external) and publicly hosted on GitHub Pages at https://turretcss.com(link is external). 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:

1. Download and install Node(link is external), which we use to manage our dependencies.
2. Navigate to the root /turret directory and run npm install to install our local dependencies listed in package.json(link is external).
3. Install Ruby(link is external), install Bundler(link is external) with gem install bundler, and finally run bundle install. This will install all Ruby dependencies, such as Jekyll and plugins.

• Windows users: Read this unofficial guide(link is external) 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:

Autoprefixer

turretcss uses Autoprefixer(link is external) as part of postcss-preset-env to automatically add vendor prefixes to some CSS properties at build time.

Running documentation locally

1. Install Install Ruby(link is external), install Bundler(link is external) with gem install bundler.
2. Install Jekyll (the site builder) and other Ruby dependencies with bundle install. This will install all Ruby dependencies, such as Jekyll and plugins.
3. Run npm start or yarn start to rebuild CSS.
4. From the /docs directory, run bundle exec jekyll serve in the command line.
5. Open http://0.0.0.0:2001(link is external) in your browser.

Learn more about using Jekyll by reading its documentation(link is external).

Troubleshooting

Should you encounter problems with installing dependencies or running scripts, uninstall all previous dependency versions (global and local). Then, rerun npm install.

Updates

Keep track development updates by following @turretcss(link is external) on Twitter.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, turretcss is maintained under the Semantic Versioning guidelines(link is external).

See the Releases section of our GitHub project(link is external) for changelogs for each release version of turretcss.

Creators

Scott de Jonge

• Twitter: @scottdejonge(link is external)
• Github: @scottdejonge(link is external)

Copyright and license

Code and documentation copyright 2019 Bigfish.tv(link is external), Code released under the MIT license(link is external). Docs released under Creative Commons(link is external).