{"id":18378274,"url":"https://github.com/tyom/sculptor","last_synced_at":"2025-04-11T08:23:47.451Z","repository":{"id":17252046,"uuid":"20021445","full_name":"tyom/sculptor","owner":"tyom","description":"Tool to create style guides and prototype web apps","archived":false,"fork":false,"pushed_at":"2015-03-16T18:31:22.000Z","size":517,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-03-14T23:07:21.049Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","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/tyom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-21T13:04:42.000Z","updated_at":"2020-04-23T01:51:33.000Z","dependencies_parsed_at":"2022-07-26T14:32:04.671Z","dependency_job_id":null,"html_url":"https://github.com/tyom/sculptor","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tyom%2Fsculptor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tyom%2Fsculptor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tyom%2Fsculptor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tyom%2Fsculptor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tyom","download_url":"https://codeload.github.com/tyom/sculptor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248361050,"owners_count":21090807,"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-11-06T00:32:41.912Z","updated_at":"2025-04-11T08:23:47.428Z","avatar_url":"https://github.com/tyom.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sculptor\n\nTool to create style guides and prototype web apps.\n\n## Installation\n\nnode is required to run Bower.\n\n```\n$ gem install sculptor\n$ npm install -g bower\n```\n\n## Usage\n\nSculptor extends Middleman so all Middleman commands can also be used.\n\n### Initiate new project\n\nFetches and installs dependencies and creates project skeleton.\n\n```\nsculptor init project-name\n```\n\nAliases: `i`, `new`, `n`.\n\nThis command will create scaffold for new project and install client dependencies via Bower.\nMake sure Bower is installed globally (`npm install -g bower`).\n\n### Create new model\n\nIn project root directory run:\n\n```\nsculptor create model-name\n```\n\nAlias `c`.\n\nModels are sub-project which are contained in directories.\nSeveral similar modules can be created in one directory:\n\n```\nsculptor c model-name/variant\n```\n\nIf no variant is specified the initial variant is created with the same name as directory\n\nAn index file is generated for ech directory.\n\nWhen createing a new model its path is shown and the following questions asked:\n\n- **Title:** (optional)- title for the model created\n- **Description:** (optional) - model description\n- **Stylesheet:** (optional) - stylesheet file name, created in the model directory and automatically included in the model\n- **Use iframe?** (`y`/`n` default `n`) - whether to encapsulate the model in iframe or render directly on page (to prevent style leaking)\n- **Include data?** (`y`/`n` default `n`) - whether to include YAML file for model mock data\n\n### Running test server\n\nRuns development server with LiveReload.\n\n```\nsculptor server\n```\n\nRunning `sculptor` without any parameters is aliased to `sculptor server`.\n\n### Building the gallery\n\nGenerates static version of project in `build` directory.\n\n```\nsculptor build\n```\n\nThe build can be distributed/viewed in standalone mode.\n\nOn OSX running `build/launch.command` afterwards will run Python's SimpleHTTPServer on port 8000 and open browser with project.\n\n\n## Sculptor template helpers\n\nSculptor is using Slim templates internally but should work with other templates supported by Middleman in projects.\n\n### Model helpers\n\n* `model`\n  - `url` (String) - first optional parameter is URL to the page with the component\n  - `title`\n  - `description`\n  - `pretty` {boolean}\n    whether to try to reformat the HTML (e.g. if remote HTML is minified)\n  - `css` - CSS selector to extract from the remote page. If specific element is required it can be selected by providing `#\u003c0-based index\u003e` at the end of selector separated by space. e.g. `img #0` will select the first image.\n  - `data` - local data that can be injected in a local component (partial with `.component.slim` extension)\n    type of source code used for code highlighting\n* `model_iframe`\n* `html` - Generate source code for HTML\n* `outline` - Generate outline of HTML structure\n\n### Resource helpers\n* `include_stylesheets`\n* `include_stylesheet`\n* `include_javascripts`\n* `relative_dir`\n* `resource_file`\n* `resource_dir`\n* `resources_for`\n  - `dir` - target directory for resources list (required)\n  - `ext` - filter resources with matching extension (default: 'html')\n  - `exlude_indexes` - whether to exclude directory index files (default: false)\n  - `sort_by` - sort resources by (defaults to `resource.url`)\n* `append_class`\n\n### Data helpers\n* `load_data`\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftyom%2Fsculptor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftyom%2Fsculptor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftyom%2Fsculptor/lists"}