An open API service indexing awesome lists of open source software.

https://github.com/jonrohan/styleguide

This is my personal coding styleguide. I try to cover how I write HTML, CSS, JavaScript and Ruby
https://github.com/jonrohan/styleguide

Last synced: over 1 year ago
JSON representation

This is my personal coding styleguide. I try to cover how I write HTML, CSS, JavaScript and Ruby

Awesome Lists containing this project

README

          

# :sparkles: Personal styleguide :sparkles:

Sometimes another developer will ask me. *"Hyphens or underscores?"* *"Spaces or tabs?"* That's when I realized that creating a personal styleguide would be the best thing ever.

This styleguide is how I write code. Styleguides are meant to help teams of developers to create a strategy on how they write their code. If you find this useful, I encourage you to [fork it](https://github.com/jonrohan/styleguide) and use it for your own team's guide.

I setup [a nice site](http://jonrohan.codes/styleguide/) for the style guide, but you can also read through it on GitHub. ToC below.

## Table of contents

* [Editor](./editor/_drafts/README.md)
* [Coding style](./editor/_drafts/style.md)
* [Linting](./editor/_drafts/linting.md)
* [CSS](./css/_drafts/README.md)
* [Coding style](./css/_drafts/style.md)
* [CSS units](./css/_drafts/units.md)
* [Declarations](./css/_drafts/declarations.md)
* [Selectors](./css/_drafts/selectors.md)
* [HTML](./html/_drafts/README.md)
* [Coding style](./html/_drafts/style.md)
* [Meta](./html/_drafts/meta.md)

## Install

If you really want to run this locally, here's what works on my machine ™

```
bundle install
bundle exec jekyll serve
open http://localhost:4000/
```

## Usage

I've created a nice little bundle of editor style goodies that will match my coding style. You can [download here](https://github.com/jonrohan/styleguide/releases/download/v0.0.1/config.zip).

## Related

This styleguide is inspired by some styleguides from these awesome developers and organizations.

* [codeguide.co](http://codeguide.co/) by [@mdo](https://github.com/mdo)
* [idiomatic-css](https://github.com/necolas/idiomatic-css) by [@necolas](https://github.com/necolas)
* [Javascript](https://github.com/airbnb/javascript) by [@airbnb](https://github.com/airbnb)

## License

MIT © [Jon Rohan](http://jonrohan.codes/)