{"id":19730517,"url":"https://github.com/begriffs/styleguide_rails","last_synced_at":"2025-07-25T07:35:33.104Z","repository":{"id":3964908,"uuid":"5058982","full_name":"begriffs/styleguide_rails","owner":"begriffs","description":"generate a living styleguide with one command","archived":false,"fork":false,"pushed_at":"2015-09-24T17:44:29.000Z","size":578,"stargazers_count":70,"open_issues_count":12,"forks_count":10,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-07-01T02:06:35.087Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/begriffs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-07-15T18:54:35.000Z","updated_at":"2025-05-23T19:23:24.000Z","dependencies_parsed_at":"2022-09-14T15:22:14.969Z","dependency_job_id":null,"html_url":"https://github.com/begriffs/styleguide_rails","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/begriffs/styleguide_rails","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/begriffs%2Fstyleguide_rails","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/begriffs%2Fstyleguide_rails/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/begriffs%2Fstyleguide_rails/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/begriffs%2Fstyleguide_rails/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/begriffs","download_url":"https://codeload.github.com/begriffs/styleguide_rails/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/begriffs%2Fstyleguide_rails/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266973786,"owners_count":24014776,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-25T02:00:09.625Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T00:16:37.839Z","updated_at":"2025-07-25T07:35:33.077Z","avatar_url":"https://github.com/begriffs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Adds a [living style\nguide](http://24ways.org/2011/front-end-style-guides/) to your Rails\napplication with one command.\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://youtu.be/V4L4oHtL1Sk\"\u003e\u003cimg src=\"illustration/video_still.png\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nIf you don't use a CSS style guide yet, here's why you should start:\n\n\u003cimg src=\"illustration/logo.png\" alt=\"Styleguide Rails Logo\" align=\"right\" /\u003e\n\n* __It Makes Testing Easier.__ With all your styles in one place you can easily\ncheck for browser bugs, resizing issues, text zoom issues, and printable\nstyle. Putting examples of all styles in one place means you don't have to\nreproduce application states to see error messages etc.\n* __It Unifies Design.__ Designing shared components all at once fights the\ntemptation to have one-off page styles. This increases the coherence of\nyour design, making it less likely that styles drift between pages. It\nalso encourages cleaner markup.\n* __It Standardizes Vocabulary.__ Style guides list all your widgets along with\nnames you have chosen. By referring to the guide, your team can settle\non common vocabulary for parts of the page. (e.g. \"What does my team\ncall this thing on the front page, a slider, a carousel, a flipper, or\nwhat?\")\n* __It Promotes Excellent Markup.__ The styleguide contains examples of your\ndesired canonical markup for various elements. Nobody needs to guess how\nto create a menu or a form. Also your best front-end engineers can write\nthe markup and teach good habits.\n\n## Usage\n\nAdd this gem to your Rails Gemfile:\n\n    gem 'styleguide_rails'\n\nRun `bundle`, and execute the styleguide generator:\n\n    rails generate styleguide:install\n\nThat's it, you're done, you have a styleguide available at\n`http://yourapp.com/styleguide`. If you visit that path you'll see there\nis an example widget already created:\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"illustration/screenshot.png\" alt=\"Screenshot\" /\u003e\n\u003c/p\u003e\n\nTo add a new widget, run\n\n    rails generate styleguide:widget NAME\n\nwhich will create a partial in `app/views/styleguide/widgets` and it\nwill appear in the style guide. These partials support templating\nlanguages like Haml if you have the gems installed.\n\n## Live Reloading\n\nStyleguide Rails can reload your browser whenever you change a CSS file\nor a widget. This instant feedback is helpful for adjusting the styles.\nTo enable live reloading,\n\n* Install the [LiveReload](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei?hl=en)\n  plugin for Google Chrome.\n* Add `gem 'guard'` and `gem 'guard-livereload', '~\u003e 2.4', require: false` to your `Gemfile`\n* Run `bundle`\n* Run `guard` in a new terminal window\n* Be sure you enable the LiveReload plugin in Chrome. Just click its\n  icon.\n\n## Credits\n\nThanks to project\n[contributors](https://github.com/begriffs/styleguide_rails/contributors),\nand to [Adam Braus](https://github.com/ajbraus) for suggesting the\nidea for this gem.\n\n## Upgrading\n\nTo overwrite an installation of an earlier version, run\n\n    bundle update --source styleguide_rails\n    rails generate styleguide:install -f\n\nDon't worry, this will preserve any existing widgets.\n\n## License\n\nStyleguide_rails is Copyright © 2012 - 2013 Joe Nelson. It is free\nsoftware, and may be redistributed under the terms specified in the\nLICENSE file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbegriffs%2Fstyleguide_rails","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbegriffs%2Fstyleguide_rails","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbegriffs%2Fstyleguide_rails/lists"}