{"id":17159810,"url":"https://github.com/maximed/gulp_scaffold","last_synced_at":"2025-03-24T15:08:54.320Z","repository":{"id":141377200,"uuid":"47349194","full_name":"MaximeD/gulp_scaffold","owner":"MaximeD","description":"Scaffold for a static website using gulp","archived":false,"fork":false,"pushed_at":"2016-09-25T07:25:54.000Z","size":830,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-29T19:49:22.115Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CoffeeScript","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/MaximeD.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-12-03T17:44:15.000Z","updated_at":"2024-08-24T23:41:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"d45eaf6e-9593-426b-b9b9-90f1319c322f","html_url":"https://github.com/MaximeD/gulp_scaffold","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaximeD%2Fgulp_scaffold","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaximeD%2Fgulp_scaffold/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaximeD%2Fgulp_scaffold/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaximeD%2Fgulp_scaffold/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MaximeD","download_url":"https://codeload.github.com/MaximeD/gulp_scaffold/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245294768,"owners_count":20591900,"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-10-14T22:15:11.115Z","updated_at":"2025-03-24T15:08:54.289Z","avatar_url":"https://github.com/MaximeD.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Take a look at the [demo](http://maximed.github.io/gulp_scaffold/dist/)\nand the [code](https://github.com/MaximeD/gulp_scaffold/tree/gh-pages) running it.\n\n# Structure\n\nFiles for development are stored in `src/`\nwith the following structure:\n\n```\n+ src/\n| \\-- assets\n|     \\-- images\n|     \\-- javascripts\n|     \\-- static\n|     \\-- stylesheets\n|         \\-- variables.scss\n| \\-- templates\n|     \\-- layout.html\n| \\-- views\n```\n\nResult will be stored inside `/dist`.\n\n## `src/assets`\n\n### `src/assets/images`\n\nYour image will be processed by [gulp-imagemin](https://www.npmjs.com/package/gulp-imagemin).\nIt is responsible to compress them.\n\nThey will be placed in `/dist/images`.\n\n### `src/assets/javascripts`\n\nPlace here `coffee` files.\nThey will be turned into javascript, obfuscated, minified,\nand merged into a single file `all.js`.\n\nIt will be placed in `/dist/js/all.js`.\n\n\n### `src/assets/static`\n\nIf you have any static files that should not be processed by `gulp`,\nyou can place them here.\nIt can be virtually anything: vendored assets, `pdfs`, …\n\nIt will be copied to `/dist` with same path without any transformation.\nSo `/src/assets/static/foo/bar/baz.txt` will be available in `/dist/foo/bar/baz.txt`.\n\n\n### `src/assets/stylesheets`\n\nPlace here `scss` files,\nThey will be turned into `css`, including `bootstrap` and `fontawesome`.\nSince it includes `bootstrap`, it means you can override its [default variables](https://github.com/twbs/bootstrap/blob/master/less/variables.less).\n\nThe result will be one single file available in `/dist/css/all.css`.\n\n## `src/templates`\n\nYou can write here templates you want to inherit from / include in other files.\nTypically, you will have a layout, a footer, etc.\n\nThis files are written using [pug](http://jade-lang.com/),\nso have a look at its [documentation](http://jade-lang.com/reference/) to see what is available.\n\nTemplates are not written anywhere for they are to be used by views.\n\n## `src/views`\n\nYour views to produce resulting `html`.\nThey can inherit or include templates and are also written using [pug](http://jade-lang.com/).\n\nThey will be built at the root of `/dist`, honoring their path,\nso `/src/views/blog/article.pug` will be inside `/dist/blog/article.html`.\n\n\n# Configuration\n\nJust read `gulpfile.coffee` and `tasks/`, it should be explanatory.\n\nThe only file you need to customize is `/tasks/routes.coffee`.\nBasically you will want to write here mapping for view files.\nThis is a matter of taste,\nbut I just find it way more convenient to write:\n```pug\na(href=routes.blog.about_gulp)\n```\nrather than\n```pug\na(href='/blog/why-gulp-rocks.html')\n```\n\n\n# Installation\n\nClone repository:\n\n```\ngit clone git@github.com:MaximeD/gulp_scaffold.git\n```\n\nInstall modules:\n\n```\n$ cd gulp_scaffold\n$ npm install --save-dev\n$ bower install\n```\n\n# Tasks\n\nThe default task (`gulp`) will create everything **but** `sitemap.xml`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaximed%2Fgulp_scaffold","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaximed%2Fgulp_scaffold","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaximed%2Fgulp_scaffold/lists"}