{"id":13612510,"url":"https://github.com/mscharley/jekyll-compass","last_synced_at":"2025-04-13T12:32:07.549Z","repository":{"id":11610234,"uuid":"14105014","full_name":"mscharley/jekyll-compass","owner":"mscharley","description":"Plugin for Jekyll and Compass to ease use of both on the same project","archived":true,"fork":false,"pushed_at":"2016-08-22T12:37:30.000Z","size":44,"stargazers_count":52,"open_issues_count":0,"forks_count":8,"subscribers_count":6,"default_branch":"develop","last_synced_at":"2024-11-07T20:42:41.329Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":false,"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/mscharley.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":"2013-11-04T09:02:55.000Z","updated_at":"2023-09-26T13:28:10.000Z","dependencies_parsed_at":"2022-09-14T09:21:39.140Z","dependency_job_id":null,"html_url":"https://github.com/mscharley/jekyll-compass","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mscharley%2Fjekyll-compass","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mscharley%2Fjekyll-compass/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mscharley%2Fjekyll-compass/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mscharley%2Fjekyll-compass/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mscharley","download_url":"https://codeload.github.com/mscharley/jekyll-compass/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248714614,"owners_count":21149926,"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","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-08-01T20:00:30.942Z","updated_at":"2025-04-13T12:32:07.266Z","avatar_url":"https://github.com/mscharley.png","language":"Ruby","funding_links":[],"categories":["Assets \u0026 Converters \u0026 Minifiers"],"sub_categories":[],"readme":"jekyll-compass: Compass generator for Jekyll websites\r\n=====================================================\r\n\r\n**GitHub:** https://github.com/mscharley/jekyll-compass  \r\n**Author:** Matthew Scharley  \r\n**Contributors:** [See contributors on GitHub][gh-contrib]  \r\n**Bugs/Support:** [Github Issues][gh-issues]  \r\n**Copyright:** 2013  \r\n**License:** [MIT license][license]\r\n\r\n**Not maintained here any longer**: [See the fork by @chikamichi](https://github.com/chikamichi/jekyll-compass)\r\n\r\nSynopsis\r\n--------\r\n\r\njekyll-compass is a plugin for both Jekyll and Compass that provides a bi-directional interface between the two\r\napplications, tightly integrating them and allowing each to work well together when either is used directly. In short,\r\nif you use Compass as well as Jekyll, jekyll-compass makes your life easier.\r\n\r\nInstallation\r\n------------\r\n\r\nThis plugin has a very simple two step install:\r\n\r\n1.  Install the gem:\r\n\r\n        $ gem install jekyll-compass\r\n\r\n2.  Add the gem to your jekyll website's `_config.yml` file:\r\n\r\n        gems:\r\n        - jekyll-compass\r\n\r\nUsage\r\n-----\r\n\r\nYou may use Compass to generate a layout and configuration for you. The site root is the folder where your `_config.yml`\r\nlives. This step is highly recommended as it will also install some plumbing to help Compass work correctly with your\r\nnew jekyll-compass project. You can also install your favourite framework directly, just remember to add the extra\r\nparameters so that Compass understands the target project structure.\r\n\r\n    compass create -r jekyll-compass --app=jekyll path/to/site/root\r\n    compass create -r jekyll-compass --app=jekyll -r zurb-foundation path/to/site/root\r\n\r\nIf you are coming from an older version of jekyll-compass and just want to install the plumbing for Compass then use\r\nthis command:\r\n\r\n    compass init jekyll -r jekyll-compass --prepare [path/to/site/root]\r\n\r\nOther `compass` commands will then work as per usual:\r\n\r\n    # Compiles all your Sass/Compass into the _site folder, or you may also specify --css-path on the command line\r\n    compass compile\r\n    compass watch\r\n\r\nYou will also note that Compass will build your Sass files whenever Jekyll builds the rest of your website, ensuring\r\nthat what you publish is always up to date.\r\n\r\n    # Compiles your entire website, including Sass/Compass\r\n    jekyll build\r\n    jekyll serve --watch\r\n\r\nConfiguration\r\n-------------\r\n\r\nYou may add a file to your `_data` folder called `compass.yml`. This will contain overrides for the compass\r\nconfiguration, similar to the `config.rb` in a regular compass project. If you generated a layout using compass above\r\nthen this file will already exist with some default settings setup for you. Any of the\r\n[regular configuration properties][compass-props] should be supported via this YAML file.\r\n\r\nCompass also provides a way to pass through options directly to Sass via the `sass_options` option. You can find\r\ndetails of what options are available from Sass in the [Sass Reference][sass-props].\r\n\r\nAn example configuration file might look like the following:\r\n\r\n    output_style: compact\r\n    sass_options:\r\n      unix_newlines: true\r\n\r\nIn order to use other plugins for compass, add them to the `require` key in your `compass.yml` file. There is also a\r\n`load` and `discover` key which map to the relevant commands in Compass' regular configuration file.\r\n\r\n    require:\r\n    - zurb-foundation\r\n\r\nThere is also a `import_paths` key which is analogous to the `add_import_path` line in `config.rb`.\r\n\r\n    import_paths:\r\n    - assets/foundation/scss\r\n\r\n  [license]: https://raw.github.com/mscharley/jekyll-compass/master/LICENSE\r\n  [gh-contrib]: https://github.com/mscharley/jekyll-compass/graphs/contributors\r\n  [gh-issues]: https://github.com/mscharley/jekyll-compass/issues\r\n\r\n  [compass-props]: http://compass-style.org/help/tutorials/configuration-reference/\r\n  [sass-props]: http://sass-lang.com/documentation/file.SASS_REFERENCE.html#options\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmscharley%2Fjekyll-compass","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmscharley%2Fjekyll-compass","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmscharley%2Fjekyll-compass/lists"}