StyleCI

The StyleCI Docs

Welcome to the StyleCI docs. You'll find comprehensive guides and documentation to help you start working with StyleCI as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Guides

Badges

Show off your perfect code style with a shiny StyleCI badge on your readme.

You can find copy and pasteable badge code on any analysis page for each repo. Simply click on the badge, and you'll be presented with the code.

Alternatively, you can simply just add /shield to the URL of the main page of your repo on StyleCI to get the badge URL.

By default, we use the "flat-square" style, but you can also choose from "flat", or "plastic" by appending "?style=flat" to "?style=square" to the badge URL.

We also support setting the branch you want by appending "?branch=your-branch" to the URL.

Here is an example badge URL for the Laravel Framework: https://styleci.io/repos/7548986/shield, and here is an example of using the plastic style for the 5.1 branch: https://styleci.io/repos/7548986/shield?style=plastic&branch=5.1.


What's Next

Slack
Change Log

Badges


Show off your perfect code style with a shiny StyleCI badge on your readme.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.